To access webhooks, please contact us for more details.

The user event webhook provides a webhook notification for certain user events, like when the user connects or disconnects their social media accounts.

Method: POST

Example webhook payload:

JSON
{
  id: string;            // ID of the event, in UUIDv4
  type: string;          // Type of the event, e.g., 'CONNECT_TWITTER'
  timestamp: string;     // ISO 8601 format, e.g., '2023-10-05T12:34:56Z'
  payload: any;          // Data associated with the event
  metadata?: any;        // Additional information
}

​
Protecting your webhook

In order for Terminal 3 to communicate with your application, you will need a publicly accessible URL. You’ll want to protect this URL so that malicious actors cannot access it.

​
Request authorization

Bearer token may be included in the authorization header to help authenticate the requests.

Please generate an authentication token and provide it to Terminal 3.

The authorization request header will have the following format:

JSON
{
  "Authorization": "Bearer <your_auth_token>"
}