List Subscriptions

This endpoint is used to return all subscriptions that have been created for the given webhook.

Path parameters

Parameters marked are required.

Parameter Name	Description	Type	Example Data
webhookId	The unique id of the webhook that you want to display the subscriptions for.	numeric	1

Example request

curl --location --request GET 'https://api.claimsmanagertest.crawco.co.uk/webhooks/1/subscriptions' \
--header 'Authorization: Bearer {access token}'

Response body parameters

Parameter Name	Description	Type	Example Data
webhookSubscriptionId	The unique id of the subscription.	numeric	1
webhookId	The unique id of the webhook.	numeric	1
name	The unique name given to the subscription.	string	Test Subscription
webhookEvent	The name of the webhook event that this subscription is subscribing to.	string	New Event
isActive	When set to false, this subscription is disabled.	boolean	true
filters	Object containing any filters defined for this subscription.	object	See Filters

Example response

[
    {
        "webhookSubscriptionId": 1,
        "webhookId": 1,
        "name": "Test Subscription",
        "webhookEvent": "New Event",
        "isActive": true,
        "filters": {
            "fields": [
                {
                    "name": "eventType",
                    "operator": "equals",
                    "value": "Event Log Entry"
                },
                {
                    "name": "category",
                    "operator": "equals",
                    "value": "Report: Final"
                }
            ]
        }
    }
]