Get Webhooks

Fetch a list of all webhooks available for a user.

/webhooks

GET https://api.terminal.africa/v1/webhooks

This endpoint allows you to get a list of existing webhooks.

Query Parameters

Name	Type	Description
perPage	number	Specify how many results will be returned in a single request. Defaults to 100.
page	number	Specify the page of results that will be returned in request. Defaults to 1.

200: OK Webhooks retrieved successfully.

{
    "status": true,
    "message": "Webhooks retreived successfully",
    "data": {
        "webhooks": [
            {
                "_id": "62a0b6dc28bf3cef7bb936fd",
                "active": false,
                "event":  [
                    "shipment.created",
                    "shipment.updated"
                ],
                "live": false,
                "name": "My Test Webhook",
                "url": "https://webhook.site/f80b40b7-8004-4fd9-82c0-40f6ccb41cd1",
                "user": "USER-12568655307",
                "webhook_id": "WA-85241442320",
                "created_at": "2022-06-08T14:49:00.190Z",
                "updated_at": "2022-08-01T11:30:54.678Z",
                "__v": 0,
                "id": "62a0b6dc28bf3cef7bb936fd"
            }
        ],
        "pagination": {
            "page": 1,
            "perPage": 100,
            "prevPage": null,
            "nextPage": null,
            "currentPage": 1,
            "total": 1,
            "pageCount": 1,
            "pagingCounter": 1,
            "hasPrevPage": false,
            "hasNextPage": false
        }
    }
}