latestOpenAPI 3.1.12026-08-2013060964.7 KB

9a5a2cd152ae

Trigger an Event

API to pass an event, which in turn triggers workflows where that event is defined as the trigger.

post/event/

Request body

distinct_idstring required

distinct_id of recipient who should receive the notification

eventstring required

string identifier for the event like product_purchased

tenant_idstring

string identifier of the tenant this event is associated with

$idempotency_keystring

Idempotency key (valid for 24hours)

Example request

{
  "properties": {
    "$attachments": [
      {
        "url": "https://bitcoincore.org/bitcoin.pdf",
        "filename": "billing.pdf"
      }
    ]
  }
}

Response

202 - Accepted

messagestring

Status message indicating the event was accepted.

Example response

{
  "message": "OK"
}