Custom Events

Custom events can be sent on the FT CRM Integration API. This event gives you the possibility to trigger any events.

⬆️ POST /v1/integration/custom

This endpoint is used to send real time custom events. Examples could be the user clicks a password forgotten button, or the weather changes from rain to sunny, only your imagination sets the limits. You use these events to bind real time activities and actions in FT CRM later on. You could also use these custom events as segmentation rules. Contact your Partner/Integration Manager on how to proceed.

{
	"notification_type": "password_forgotten",
	"user_id": "123456",
	"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.116 Safari/537.36",
	"ip_address": "192.168.1.1",
	"timestamp": "2020-03-02T8:27:58.721607+00:00",
	"origin": "sub.example.com",
	"data": {
		"password_unlock_code": "abc123"
	}
}

Key

Type

Required

Description

notification_type

String

Yes

The key of this custom event.

user_id

String

Yes

The user id this event belongs to.

origin

String

Yes

The origin of this call.

timestamp

RFC3339 Datetime

Yes

When this was called / initiated.

data

Key-Value object with strings (as in the examples above)

Yes

Additional data to provide for this specific event.

user_agent

String

No

The user agent for the user which triggered this.

ip_address

Valid IP-Address

No

From where this was called / initiated.

If you want to override the automated failsafe of "blocked" or "excluded" players you can do so by adding these extra parameters in the data field payload of the Custom Event:

{
	"notification_type": "password_forgotten",
	"user_id": "123456",
	"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.116 Safari/537.36",
	"ip_address": "192.168.1.1",
	"timestamp": "2020-03-02T8:27:58.721607+00:00",
	"origin": "sub.example.com",
	"data": {
		"password_unlock_code": "abc123",
		"allow_to_send_blocked": true,
		"allow_to_send_excluded": true
	}
}

Last updated

Was this helpful?