Docs
Dashboard Get an API key

Objects

The webhook object

A webhook is an endpoint of yours that Sigil posts events to: its URL, the events it wants, whether it is active, and how its deliveries have been going.

Returned by every call under /webhooks. The secret appears only when the endpoint is created and when its secret is rolled. See the webhooks guide for what is posted and how to verify it.

Attributes

uidstring
The endpoint's id: 8 letters and digits.
urlstring
Where events are posted: a public HTTPS URL.
descriptionstring | null
Your note on what it is for (100 characters at most).
eventsarray of strings | null
The event types it receives, or null for every pact event. A ping is delivered whatever this says.
activeboolean
Whether events are delivered to it. Switched off by you, by a 410 Gone answer, or after 10 failed deliveries in a row; switch it on again with Update a webhook.
consecutive_failuresinteger
Deliveries given up on since the last success. Resets to 0 on the next success.
last_statusinteger | null
The HTTP status of the last attempt. null before the first attempt, and when the last attempt got no response.
date_last_successstring (date-time) | null
When a delivery last got a 2xx.
date_disabledstring (date-time) | null
When it was switched off, while it is.
date_createdstring (date-time)
When it was added.
date_updatedstring (date-time)
When its settings or secret last changed.
secretstring
The signing secret, sgw_ and 40 letters and digits. Keep it where your receiver can read it.
Only in the response to Create a webhook and Roll the secret. It cannot be read back later.