This feature allows your system to receive real-time updates whenever a user subscribes or unsubscribes from communications in InTarget.
The event may originate from:
an email campaign (e.g., a user clicks Unsubscribe),
a user action via an API email link,
an action inside the InTarget CRM (e.g., a user was unsubscribed manually), or
an automatic system action (e.g., bounce or complaint).
InTarget sends these updates to your webhook endpoint in JSON format.
Quick Start
Provide a webhook URL (HTTPS recommended) to your InTarget manager.
The endpoint must accept
POSTrequests withContent-Type: application/json.Return
200 OKwithin 5 seconds after receiving the event.
Event Payload
json
{
"event":"unsubscribe | subscribe",
"channel":"...",
"type":"...",
"value":"contact (email, phone, etc.) | null",
"playerId":"player ID | null",
"occurredAt":"2026-03-04 12:00:00",
"extra":{
}
}Field Reference
Field | Type | Description |
|
|
|
|
| The source of the event. See |
|
| The communication type affected — |
|
| The actual contact value (email address, phone number, push token, etc.). |
|
| The player ID associated with the contact, or |
|
| Time of the event in |
|
| Additional context depending on the channel. See |
channel
Value | Description |
| Event triggered inside the InTarget CRM (e.g., manually un/re-subscribed). |
| Unsubscribed via link in an API-sent email. |
| Unsubscribed or re-subscribed via link in a campaign email. |
| Automatically unsubscribed by the system due to a bounce or complaint. |
extra
Key | Type | When present | Possible values |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| ID of the API email template that contained the unsubscribe link |
|
|
| Campaign ID |
