Update a Webhook Subscription
Header Parameters
Path Parameters
Subscription Id.
Body Parameters
Optional list of account IDs to scope the subscription to. When provided and non-empty, notifications are sent only for events on these accounts or their descendants. When omitted or empty on create, the subscription defaults to the caller's root account(s). When omitted or empty on update, existing accounts are preserved. Accounts must belong to the caller's root account hierarchy.
Show child attributes
Subscription callback url. Must be a valid HTTP or HTTPS URL.
Subscription End Date. For search operations: Filter subscriptions that are active on or before this date (i.e., whose start date is on/before this date).
Subscription Start Date. For search operations: Filter subscriptions that are active on or after this date (i.e., whose end date is null or on/after this date).
Subscription status
ENABLEDPENDINGDISABLEDResponse
Updated Webhook Subscription
Response Attributes
HATEOAS links to subscription-related resources
Show child attributes
Optional list of account IDs to scope the subscription to. When provided and non-empty, notifications are sent only for events on these accounts or their descendants. When omitted or empty on create, the subscription defaults to the caller's root account(s). When omitted or empty on update, existing accounts are preserved. Accounts must belong to the caller's root account hierarchy.
Show child attributes
Subscription callback url. Must be a valid HTTP or HTTPS URL.
Subscription Domain.
AUTHORIZATIONDRIVERCARDVEHICLESubscription End Date. For search operations: Filter subscriptions that are active on or before this date (i.e., whose start date is on/before this date).
Subscription Id.
Secret token for webhook HMAC signature. Only provided on the initial creation of the subscription.
Subscription Start Date. For search operations: Filter subscriptions that are active on or after this date (i.e., whose end date is null or on/after this date).
Subscription status
ENABLEDPENDINGDISABLED400 (Bad Request)
Response Attributes
401 (Unauthorized)
Response Attributes
500 (Internal Server Error)