Update a Webhook Endpoint
Webhook Endpoints
Update a Webhook Endpoint
Update an existing webhook endpoint.
Required authorization scope: public.webhook_endpoint:write
PATCH
Update a Webhook Endpoint
Authorizations
Bearer Token necessary to use API
Path Parameters
The public ID of the webhook endpoint to retrieve
Body
application/json
Update Webhook Endpoint Request
The name of the webhook endpoint
Optional description for the webhook endpoint
The URL to which the webhook payloads will be delivered
Pattern:
^https://A list of event types that the webhook endpoint will listen to
Minimum array length:
1Available options:
contact.churned, contact.converted, contact.created, contact.updated, contract.created, contract.signed, coupon.created, coupon.updated, credit_note.created, credit_note.updated, deal.created, deal.lost, deal.reopened, deal.stage_changed, deal.updated, deal.won, identity_verification.cancelled, identity_verification.failed, identity_verification.processing, identity_verification.succeeded, invoice.created, invoice.finalized, invoice.marked_uncollectible, invoice.paid, invoice.updated, note.created, note.updated, order.abandoned, order.completed, order.created, order.finalized, protection_level.created, protection_level.updated, subscription.cancelled, subscription.created, subscription.ended, subscription.resumed, subscription.started, task.completed, task.created, task.reopened, task.updated, tenancy.auto_reservation.failed, tenancy.auto_reservation.partially_succeeded, tenancy.auto_reservation.succeeded, tenancy.created, tenancy.started, unit.available, unit.created, unit.deallocated, unit.occupied, unit.overlocked, unit.repossessed, unit.reserved, unit.unavailable, unit.updated, unit_type.created, unit_type.updated Set of key-value pairs for storing additional information on the webhook endpoint. Learn more about metadata.