Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Webhook event types
The CloudEvents envelope, the event_types filter and the events delivered.
Every delivery is one CloudEvents 1.0 document, signed with Standard Webhooks.
#The envelope
| Field | Type | What it is |
|---|---|---|
specversion | string | Always 1.0. |
id | string | The event id, unique per source. The delivery header webhook-id is the key to deduplicate attempts on. |
source | string | Who produced the event. |
type | string | What happened, for example sylphx.webhook.test. |
subject | string | What the event is about. Present when the producer set it. |
time | string | When it happened, RFC 3339. Present when the producer set it. |
datacontenttype | string | The media type of data, usually application/json. |
dataschema | string | A schema URI for data, when the producer set one. |
data | any | The payload. |
CloudEvents extension attributes arrive as extra top-level members. Events a
Sylphx service published carry the extension sylphxplatform set to "true"
inside the signed body.
#Choose what an endpoint receives
spec.event_types on the endpoint takes three
forms:
| Value | Receives |
|---|---|
order.paid | That exact type. |
order.* | Every type that begins with order.. |
* | Every type of the environment (the default). |
#Events you receive
| Type | Source | When |
|---|---|---|
sylphx.webhook.test | https://api.sylphx.com/events | You call the test method. See testing. |
sylphx.notify.inbound_email.received | notify/{org}/{project}/{env}/mailboxes/{mailbox} | A mailbox of the environment receives an email. data names the mailbox and the inbound_email, and carries the envelope. |
Types that begin with sylphx. come from Sylphx services; the sylphx source
namespace is reserved, so your own events never use it.
Publishing your own events is the publish method of
the topics collection. That collection is declared in the API reference but is
not routed on api.sylphx.com, so the two types above are what an endpoint
receives.
#Read a delivery
A delivery of an event to your endpoint is a webhook delivery: read it to see each attempt and what your endpoint answered.