Skip to main content

Get Webhook by ID

Retrieve details of a specific webhook by its ID.

Endpoint

GET /api/webhooks/:webhookId

Headers

X-API-Key: your-api-key

Parameters

Path:

  • webhookId (string, required) - The webhook ID (format: wh_ followed by 32 hex characters)

Response

{
"status": true,
"message": "Webhook retrieved successfully",
"data": {
"webhookId": "wh_a1b2c3d4e5f6789012345678901234ab",
"signingKey": "whsk_live_abc123...",
"url": "https://your-app.com/webhooks",
"isActive": true,
"application": {
"id": "507f1f77bcf86cd799439011",
"name": "My Application",
"clientId": "your-client-id"
},
"owner": {
"id": "507f1f77bcf86cd799439012",
"name": "John Doe",
"email": "john@example.com"
},
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
}
}

Response Fields

FieldTypeDescription
webhookIdstringUnique webhook identifier
signingKeystringWebhook signing key
urlstringWebhook URL
isActivebooleanWhether the webhook is active
application.idstringApplication ID
application.namestringApplication name
application.clientIdstringApplication client ID
owner.idstringOwner user ID
owner.namestringOwner name
owner.emailstringOwner email
createdAtstringWebhook creation timestamp
updatedAtstringWebhook last update timestamp

Errors

StatusMessage
400Validation failed / Invalid webhook ID format
401Invalid API key
404Webhook not found

Example

curl -X GET "https://api.reeng.xyz/api/webhooks/wh_a1b2c3d4e5f6789012345678901234ab" \
-H "X-API-Key: your-api-key"

Notes

  • The webhook must belong to the application associated with your API key
  • Webhook ID format: wh_ followed by 32 hexadecimal characters