Webhook Config

The config property is an object that contains the webhook configuration.

Documentation

Properties

activeboolean✻

The active flag indicates whether or not the webhook is active.

Documentation

eventsarray✻

The events property is an array of webhook events.

Documentation

The event is the type of payloads that is sent to the webhook.

"Object"

Documentation

secretstring✻

The secret is a confidential string used to validate the authenticity of a webhook.

16..64 characters

Documentation

Example
"7CB188E68AC8D35DAAD456E75F5F63EB9BA7079E6C2882943573E2FE0F831708"

urlstring✻

The URL is the endpoint that will receive the webhook.

format: uri

Documentation

Example
"https://example.com/webhook"