Webhook

Represents an HTTP endpoint configured to receive event notifications from Fivetran. Webhooks let your application react to events in real time as they occur in your account. You can configure webhooks at the account level to receive events for all connections, or at the group level to receive events for connections in a specific group.

Resource attributes

The following attributes describe a webhook and its configuration.

Webhook attributes

Field name	Type	Description
`id`	string, read-only	Unique identifier of the webhook.
`type`	string, read-only	Scope of the webhook. Possible values: `account` – Receives events for all connections in the account. `group` – Receives events for connections in a specific group.
`group_id`	string, read-only	Unique identifier of the group associated with the webhook. Present only when `type` equals `group`.
`url`	string	The endpoint URL that receives webhook event payloads.
`events`	array of strings	List of event types that trigger the webhook.
`active`	boolean	Indicates whether the webhook is enabled and delivering events.
`secret`	string	Secret string used to sign webhook payloads for verification.
`created_at`	string, read-only	Date and time the webhook was created, in ISO 8601 format.
`created_by`	string, read-only	Unique identifier of the user who created the webhook.

Test response attributes

These attributes are returned when testing a webhook.

Field name	Type	Description
`succeed`	boolean, read-only	Indicates whether the test event was delivered successfully.
`status`	integer, read-only	HTTP status code returned by the webhook endpoint during the test.
`message`	string, read-only	Additional information about the test result.

Supported operations

Category	Endpoint	Description
List	`GET /v1/webhooks`	Returns a paginated list of all webhooks in the account.
Create	`POST /v1/webhooks/account` `POST /v1/webhooks/group/{groupId}`	Creates a webhook at the account level or for a specific group.
Retrieve	`GET /v1/webhooks/{webhookId}`	Returns the details of a webhook.
Update	`PATCH /v1/webhooks/{webhookId}`	Updates the configuration of an existing webhook.
Delete	`DELETE /v1/webhooks/{webhookId}`	Deletes a webhook.
Test	`POST /v1/webhooks/{webhookId}/test`	Sends a test event to the webhook endpoint to verify delivery.