Webhooks

POST /api/v3/accounts/{account_id}/webhooks/subscriptions

Changed on

Create a new webhook subscription

Request

  • Base URL
    https://cloud.getdbt.com
  • Auth
    HTTP bearer

Path parameters

account_idinteger required

Query parameters

limitinteger

The maximum number of items to return.

offsetinteger

The number of items to skip before starting to collect the result set.

Request body

idstring
namestring required

Webhook name

descriptionstring

Webhook description

job_idsinteger[]

Job IDs that trigger this webhook. Leave empty to trigger for all jobs.

client_urlstring required

Endpoint where events are sent

activeboolean required

Whether or not this Webhook is currently active

http_status_codestring

The latest HTTP status code received from the client URL. 0 indicates that the webhook has not been dispatched.

dispatched_atstring

Timestamp of when the webhook was last dispatched.

deactivate_reasonstring

Reason for deactivation

account_idinteger
account_identifierstring

Response

Changes

    • breaking

      the / request property format changed from no format to int64 (media type: application/json)

    • breaking

      the / request property format changed from no format to int64 (media type: application/x-www-form-urlencoded)

    • breaking

      the / request property format changed from no format to int64 (media type: multipart/form-data)

    • breaking

      for the path request parameter account_id, the format changed from no format to int64