Skip to main content

The Webhook object

Our Webhook API allows your application to receive real-time data updates and notifications directly from our platform. By setting up webhooks, you can automate workflows, trigger actions, and stay synchronized with events as they happen.

Attributes​

id
string
A unique identifier for the webhook.
url
string
The URL of the webhook endpoint.
events_types
array
A list of event types that trigger the webhook. Each event type corresponds to a specific action or update in the system.
attempts_count
integer
The total number of delivery attempts made for this webhook.
failed_attempts_count
integer
The number of delivery attempts that failed for this webhook.
enabled
boolean
Whether the webhook events sending is enabled or disabled.
secret
string
A secret key used to sign the webhook payloads for verification purposes.
created_at
string
The timestamp indicating when the webhook was created, in ISO 8601 format.
updated_at
string
The timestamp indicating when the webhook was last updated, in ISO 8601 format.
The Webhook object
{
  "id": "wh_4c49373b8698d4ceac793e0f",
  "url": "http://www.goodwin.com/unde-aut-iusto-quidem-amet-nihil",
  "events_types": [
    "document.created",
    "document.updated"
  ],
  "attempts_count": 0,
  "failed_attempts_count": 0,
  "enabled": true,
  "secret": "secret",
  "created_at": "2024-06-22T23:08:44+00:00",
  "updated_at": "2024-06-22T23:08:44+00:00"
}