Skip to main content
POST
Send an event to an integration hook

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

hook_id
integer
required

The numeric ID of the integration hook

Body

application/json
event
object
required

The event to run through the hook, as {"name": ..., "data": {...}}. Which names are accepted depends on the app.

Response

Success

message
string | null

What the processor produced. Null when the event was valid but produced nothing — an unrecognised event, or a conversation with too little history to act on.