Skip to main content

Webhooks

Webhooks let you receive real-time HTTP callbacks whenever a message status changes.

How it works​

  1. Register an HTTPS endpoint in the dashboard or via API
  2. Notifo sends a signed POST request to that URL on every matching event
  3. Respond with any 2xx status to acknowledge receipt

Register a webhook​

POST /v1/webhooks
Authorization: Bearer eyJ...
Content-Type: application/json
{
  "url": "https://yourapp.com/webhooks/notifo",
  "events": ["message.delivered", "message.failed"]
}
FieldTypeRequiredDescription
urlstringyesYour HTTPS endpoint
eventsstring[]noEvents to subscribe to; defaults to all events

Response

{
  "id": "wh_01j...",
  "url": "https://yourapp.com/webhooks/notifo",
  "events": ["message.delivered", "message.failed"],
  "isActive": true,
  "secret": "a1b2c3d4...",
  "warning": "Store this signing secret — it will not be shown again."
}
caution

Save the secret immediately — it is shown once and used to verify every incoming request.

Manage webhooks​

# List
GET /v1/webhooks

# Delete
DELETE /v1/webhooks/:id

# Enable
PATCH /v1/webhooks/:id/enable

# Disable
PATCH /v1/webhooks/:id/disable

Next steps​