Get a list of subscribed events
Retrieves a list of events your webhook server receives payloads for.
HTTP request
Parameters
The following table lists the parameters that this action supports.
Optional
Parameter name | Type | Description |
---|---|---|
display_all_webhook_categories | boolean | Determines whether to include a list of all supported webhook events as the |
Response
If successful, this action returns information about the webhook configuration in the response body.
List of response properties
Property name | Type | Description |
---|---|---|
webhook | nested object | The information about the webhook configuration. |
webhook.enabled | boolean | Indicates whether webhooks are turned on in your Sendbird application. (Default: |
webhook.url | string | The URL of your webhook server to receive payloads for events. |
webhook.include_members | boolean | Indicates whether to include information about group channel members in payloads. (Default: |
webhook.enabled_events[] | array of strings | An array of subscribed events. |
webhook.all_webhook_categories[] | array of strings | An array of all supported webhook events. |
In the case of an error, an error object is returned. A detailed list of error codes is available here.