Allows registering and unregistering webhooks.
This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IWebhooks>() and is defined in Telligent.Evolution.Platform.dll
Methods
Webhook Create(string callbackUrl, List<Guid> webHookIds, WebhookCreateOptions options = null);
Register a specified url as subscribed to the provided list of webhooks.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| callbackUrl | string | Callback Url | Required | ||
| webHookIds | List<Guid> | Web Hook Ids | Required | ||
| options | WebhookCreateOptions | Options | Optional |
Return Type
AdditionalInfo Delete(int callbackUrlId);
Unregister all webhooks for the specified url and remove it from the system.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| callbackUrlId | int | Callback Url Id | Required |
Return Type
Webhook Get(int id);
Retrieve a webhook.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | int | Id | Required |
Return Type
ApiList<Webhook> List();
List all urls registered against webhook events on the site.
Return Type
Webhook Update(int callbackUrlId, WebhookUpdateOptions options = null);
Update a webhook url, event listing, or other options.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| callbackUrlId | int | Callback Url Id | Required | ||
| options | WebhookUpdateOptions | Options | Optional |