List Webhooks

This API lists all webhooks.

Endpoint Information

Request Parameters

This endpoint has no URL or content parameters.

Example Usage

API Request

Below is an example HTTP raw request for the API request.

GET {{APP_URL}}/api/v1/webhooks
Content-Type: application/json
APIKEY: {{APIKEY}}

API Response

On a successful request, the API will return a response like the following:

{
    "status": true,
    "message": null,
    "data": [
        {
            "id": 42,
            "description": "Webhook for customer Clothing Store Inc.",
            "requestType": "POST",
            "dataType": "JSON",
            "endpoint": "https://c2hdev.requestcatcher.com/",
            "data": null,
            "subscribedEvent": "consignment.label.created",
            "securityType": "none",
            "securityData": [],
            "status": 1,
            "customer": {
                "id": 7
            }
        },
        {
            "id": 41,
            "description": "Webhook for customer Clothing Store Inc.",
            "requestType": "POST",
            "dataType": "JSON",
            "endpoint": "https://c2hdev.requestcatcher.com/",
            "data": null,
            "subscribedEvent": "consignment.status.delivered",
            "securityType": "none",
            "securityData": [],
            "status": 1,
            "customer": {
                "id": 7
            }
        }
    ]
}

Error Responses

If the API request fails, the API will return an error response like the following:

{
    "status": false,
    "errors": [
        {
            "message": "Unknown Error"
        }
    ]
}