Create a webhook endpoint

post

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

Creates a webhook endpoint listening for specific events.

Body Params

url

string

required

length ≤ 500

The URL of the webhook endpoint.

enabledEvents

array of objects

required

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

description

string

length ≤ 400

An optional description of what the webhook is used for.

status

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:

Response

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully created a webhook endpoint.