Enables scripted content fragments to use Webhook information
Methods
Create
Register a url with hooks to the specified webhook events.
Usage
#set($webhookResponse = $core_v2_webhook.Create($callBackUrl, $webhookEventIds, "%{IsEnabled = $isEnabledArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
callBackUrl | string | Url that event data will be sent to | Required | ||
webhookEventIds | string | Comma delimited list of webhook event identifiers to subscribe to. | Required | ||
IsEnabled | bool | Specify if the webhook should currently receive events. | Optional |
Return Type
Delete
Unregister a url completely from webhook events.
Usage
#set($additionalInfoResponse = $core_v2_webhook.Delete($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id of the webhook to be unregistered | Required |
Return Type
Get
Get a webhook.
Usage
#set($webhookResponse = $core_v2_webhook.Get($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id of webhook | Required |
Return Type
List
Lists all webhooks.
Usage
#set($apiListResponse = $core_v2_webhook.List())
Return Type
Update
Set a specified url as subscribed to only the provided list of webhook events.
Usage
#set($webhookResponse = $core_v2_webhook.Update($id, "%{CallBackUrl = $callBackUrlArg, IsEnabled = $isEnabledArg, RegenerateSecret = $regenerateSecretArg, WebhookEventIds = $webhookEventIdsArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id of webhook | Required | ||
CallBackUrl | string | Url that event data will be sent to | Optional | ||
IsEnabled | bool | Specify if the webhook should currently receive events. | Optional | ||
RegenerateSecret | bool | Specify whether the secret hash token should be regenerated. | Optional | ||
WebhookEventIds | string | Comma delimited list of webhook event identifiers to subscribe to. | Optional |