Skip to main content
POST
Fire Custom Event

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id
string
required
hub_id
string
required

Body

application/vnd.api+json
event_type
string
required
Required string length: 1 - 100
idempotency_key
string
required
Required string length: 1 - 128
team_contact_id
string
required
Minimum string length: 1
payload
Payload · object

Response

Successful Response

Top-level meta-only response for POST /automations/events.

JSON:API allows a top-level meta without data for non-resource responses (§ 7.1 "Top Level"). This is used for the custom-event fire endpoint which writes an outbox row but does not return a resource.

meta
CustomEventAcceptedMeta · object
required

meta payload for the POST /automations/events response.

Returned on both 202 (new event) and 200 (duplicate/deduped) responses. accepted is True when the event was newly written; False when the idempotency_key was already present (dedup).