API Reference
Help Center

Update a webhook endpoint

patch
https://api.ycloud.com/v2/webhookEndpoints/

Updates a webhook endpoint, such as url, events, status.

Path Params
string
required

ID of the webhook endpoint.

Body Params
string
length ≤ 500

The URL of the webhook endpoint.

enabledEvents
array of objects

The list of events to enable for this endpoint.

enabledEvents
eventProperties
array of objects

Optional configuration for event properties in webhook payloads. Specifies which properties should be included for specific event types. When enabledEvents contains contact.attributes_changed, this field is required and must contain at least one event property configuration for that event type.

eventProperties
string
length ≤ 400

An optional description of what the webhook is used for.

string
enum

Webhook endpoint status.

  • active: Indicates that the webhook endpoint is active, and will receive notifications of events monitored.
  • disabled: Indicates that the webhook endpoint is disabled, and will not receive notifications.
  • pending: Indicates that the webhook endpoint is pending, and will not receive notifications. If a webhook endpoint fails to receive notifications frequently, it changes to pending.
Allowed:
Responses

Updated 12 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 12 months ago