Getting all webhooks

Getting all webhooks

Contents

• Overview
• Version-specific information
• Permissions and Authentication
• Headers
• HTTP Parameters
• Example response JSON
• Possible error responses

Overview

• Call name: get-webhooks
• Endpoint URL: https://{API hostname}/internal/get-webhooks
• Request methods: GET
• Response Content-Type: application/json
• Auth required: yes

This endpoint retrieves all webhook configurations for a chain. By default, both active and inactive webhooks are returned; use the exclude_inactive parameter to filter out inactive webhooks.

Version-specific information

The following version-specific changes apply to this endpoint. See the versioning page for more details.

Version	Change details
N/A	N/A

Permissions and Authentication

This API call requires a valid Spaaza session. See the authentication page for more details. The session can be as follows:

• Admin authentication: The performing user needs to be logged in and have read access to the chain.

Headers

The following headers can/must be passed to the API call:

Parameter	Description
N/A	N/A

HTTP Parameters

The following HTTP parameters can be passed to the API:

Parameter	Description
chain_id	(integer, mandatory) The ID of the chain for which to retrieve webhook configurations.
exclude_inactive	(boolean, optional) When set to true, only active webhooks are returned. When false or not provided, both active and inactive webhooks are included.

Example response JSON

The endpoint returns JSON with an array of webhook configurations. An example response is shown below:

{
    "result": {
        "code": 1,
        "status": "ok"
    },
    "results": {
        "webhooks": [
            {
                "active": true,
                "applies_legacy_hmac": false,
                "campaign_id": null,
                "created_date": "2026-06-20T10:00:00+00:00",
                "event_name": "shopper.voucher-issued",
                "event_trigger": null,
                "filter": null,
                "id": 1234,
                "identifier_key": null,
                "identifier_secret": null,
                "is_default": false,
                "last_modified_date": "2026-06-20T10:00:00+00:00",
                "payload_spaaza_api_version": "1.4.8",
                "send_from": null,
                "task_id": null,
                "type": "https",
                "url": "https://example.com/webhooks/spaaza",
                "webhook_signature": {
                    "active": true,
                    "chain": {
                        "id": 1743,
                        "name": "ACME Retail"
                    },
                    "created_date": "2026-06-20T09:55:00+00:00",
                    "deleted": false,
                    "id": 56,
                    "last_modified_date": "2026-06-20T09:55:00+00:00",
                    "value": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
                }
            },
            {
                "active": true,
                "applies_legacy_hmac": false,
                "campaign_id": 170,
                "created_date": "2026-06-22T14:30:00+00:00",
                "event_name": "shopper.points-mutation",
                "event_trigger": null,
                "filter": null,
                "id": 1235,
                "identifier_key": null,
                "identifier_secret": null,
                "is_default": false,
                "last_modified_date": "2026-06-22T14:30:00+00:00",
                "payload_spaaza_api_version": "1.4.8",
                "send_from": null,
                "task_id": null,
                "type": "https",
                "url": "https://example.com/webhooks/points",
                "webhook_signature": null
            }
        ],
        "result_type": "get-webhooks"
    }
}

Possible error responses

Code	Name	Description	HTTP Status
3	http_vars_missing	Required parameter chain_id is missing	400
6	no_valid_session	No valid session key provided or session has expired	401
68	permission_denied_or_non_existent	User has insufficient permissions or the chain does not exist	403
76	chain_id_invalid	The chain_id passed must be an integer	400