Events - Notifique

Event = fact name (order.paid). Your backend triggers; ENABLED automations with that trigger create runs. Not the same as Notifique channel delivery webhooks.

What is an event?

A name contract between your system and automations. You register it (optionally with schemaJson), attach automations to eventName, and trigger with Send event.

Event × automation webhook × inbound message

	Event (API)	HTTP webhook	Inbound message
Who starts	Your backend	External system (POST)	Customer on channel
Config	Name + schema	URL/secret on automation	Inbound trigger in graph
Data	JSON `payload`	POST body	Message text/media

This page focuses on API events. Other triggers are set in the automation editor.

Register

{
  "name": "order.paid",
  "schemaJson": {
    "orderId": "string",
    "total": "number"
  }
}

Scope: events:write. Routes in Automations and events spec.

Trigger

{
  "event": "order.paid",
  "email": "customer@example.com",
  "payload": {
    "orderId": "ORD-99",
    "total": 150.0
  }
}

Recipient: contactId, email, or phone
Idempotency-Key header recommended
Response: list of runs (one per linked automation)

Best practices

Stable names: order.paid, user_created
Small payload (IDs, amounts, dates)
One trigger can start several automations, plan volume and credits

Scopes

Action	Scope
List / get	`events:read`
Create, update, delete, trigger	`events:write`

​What is an event?

​Event × automation webhook × inbound message

​Register

​Trigger

​Best practices

​Scopes

​Next steps

What is an event?

Event × automation webhook × inbound message

Register

Trigger

Best practices

Scopes

Next steps