Get Webhook

This API allows users to query a webhook by its webhook ID.

Endpoint Information

Property	Value
URL	`{{APP_URL}}/api/v1/webhooks/{webhook_id}`
HTTP Method	`GET`
Content Type	`application/json`
Authentication	`APIKEY` header

Request Parameters

URL Parameters

Parameter Name	Parameter Type	Required	Description
`webhook_id`	Integer	REQUIRED	Webhook ID

Example Usage

API Request

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

GET {{APP_URL}}/api/v1/webhooks/1
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": 1,
        "description": "Webhook for customer ComToHome Admin",
        "requestType": "POST",
        "dataType": "JSON",
        "endpoint": "https://c2hdev.requestcatcher.com/",
        "data": null,
        "subscribedEvent": "consignment.status.updated",
        "securityType": "none",
        "securityData": [],
        "status": 1,
        "customer": {
            "id": 1
        }
    }
}

Error Responses

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

{
    "status": false,
    "errors": [
        {
            "message": "Webhook not found"
        }
    ]
}