Skip to main content
GET
/
v1
/
webhooks
/
{webhook_id}
Retrieve a Webhook
curl --request GET \
  --url https://api.example.com/v1/webhooks/{webhook_id}

​
Description

This endpoint retrieves details for a specific webhook configuration.

​
Authentication

Requires API credentials:
  • Client ID (header)
  • Access Key (header)

​
Path Parameters

ParameterTypeRequiredDescription
webhook_idstringYesThe unique identifier of the webhook to retrieve

​
Response

​
Success Response (200 OK)

Returns webhook configuration details in JSON format. 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "webhook_url": "http://example.com/",
  "events": [
    "task-status-updated",
    "order-status-updated"
  ],
  "env_type": "dev",
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z"
}

​
Error Responses

401 Unauthorized: Authentication failed - invalid or missing credentials. 403 Forbidden: Access forbidden - insufficient permissions. 404 Not Found: Webhook not found.