Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    Webhook

    Get a list of subscribed events

    Retrieves a list of events your webhook server receives payloads for.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/applications/settings/webhook
    

    Parameters

    The following table lists the parameters that this action supports.

    Optional
    Parameter nameTypeDescription

    display_all_webhook_categories

    boolean

    Determines whether to include a list of all supported webhook events as the all_webhook_categories property in the response. (Default: false)

    ?display_all_webhook_categories=true
    

    Response

    If successful, this action returns information about the webhook configuration in the response body.

    {
        "webhook": {
            "enabled": true,
            "url": "https://example.com/chat/notifications",
            "include_members": true,
            "enabled_events": [
                "open_channel:create",
                "group_channel:create",
                "group_channel:leave"
            ],
            "all_webhook_categories": [
                "open_channel:create",
                "open_channel:remove",
                "open_channel:enter",
                "open_channel:exit",
                "open_channel:message_send",
                "open_channel:message_update",
                "open_channel:message_delete",
                "group_channel:create",
                "group_channel:changed",
                "group_channel:remove",
                "group_channel:invite",
                "group_channel:decline_invite",
                "group_channel:join",
                "group_channel:leave",
                "group_channel:message_send",
                "group_channel:message_read",
                "group_channel:message_update",
                "group_channel:message_delete",
                "group_channel:freeze_unfreeze",
                "group_channel:reaction_add",
                "group_channel:reaction_delete",
                "user:block",
                "user:unblock",
                "operators:register_by_operator",
                "operators:unregister_by_operator",
                "message:report",
                "user:report",
                "open_channel:report",
                "group_channel:report",
                "alert:user_message_rate_limit_exceeded",
                "profanity_filter:replace",
                "profanity_filter:block",
                "profanity_filter:moderate",
                "image_moderation:block",
                "announcement:create_channels",
                "announcement:send_messages"
            ]
        }
    }
    

    List of response properties

    Property nameTypeDescription

    webhook

    nested object

    The information about the webhook configuration.

    webhook.enabled

    boolean

    Indicates whether webhooks are turned on in your Sendbird application. (Default: false)

    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: false)

    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.