Skip to content

Update Webhook

Endpoint

http
PATCH /webhook/{id}

Path parameters

id
string
REQUIRED · The ID of the webhook to update.

Request Body

target_url
string
The URL where the webhook payload will be sent.
Example: https://example.com/webhook
is_active
boolean
Whether the webhook is active or not.
Example: true
event_types
string[]
The list of event types that the webhook is subscribed to. If not specified, then the webhook will be subscribed to all event types.
All possible enum values:
  • sync_job_run:created
  • sync_job_run:updated
  • sync_job_run:started
  • sync_job_run:completed
  • sync_job_run:failed
  • sync_job_run:record
  • integrated_account:created
  • integrated_account:updated
  • integrated_account:active
  • integrated_account:post_install_error
  • integrated_account:validation_error
  • integrated_account:post_connect_form_submitted
  • record:created
  • record:updated
  • record:deleted

Response Body

id
string · uuid
The ID of the webhook.
Example: 4a4de828-f4db-4c9e-adfd-434e0864c3c7
target_url
string
The URL where the webhook should send the data.
Example: https://example.com/webhook
is_active
boolean
Whether the webhook is active or not. Inactive webhooks will not receive any data.
Example: true
environment_id
string · uuid
The ID of the environment that this webhook belongs to.
Example: 05daecaf-4365-42e8-8370-8127de5dd717
event_types
string[]
The list of event types that the webhook is subscribed to.
Example: ["integrated_account:created", "integrated_account:updated"]
All possible enum values:
  • sync_job_run:created
  • sync_job_run:updated
  • sync_job_run:started
  • sync_job_run:completed
  • sync_job_run:failed
  • sync_job_run:record
  • integrated_account:created
  • integrated_account:updated
  • integrated_account:active
  • integrated_account:post_install_error
  • integrated_account:validation_error
  • integrated_account:post_connect_form_submitted
  • record:created
  • record:updated
  • record:deleted
created_at
string · date-time
The date and time when the webhook was created.
Example: 2021-08-10T10:00:00.000Z
updated_at
string · date-time
The date and time when the webhook was last updated.
Example: 2021-08-10T10:00:00.000Z