Skip to main content
GET
/
organizations
/
{organizationId}
/
webhooks
/
{id}
Get webhook by ID
curl --request GET \
  --url http://sandbox.mintlify.com/organizations/{organizationId}/webhooks/{id} \
  --header 'Authorization: Bearer <token>'
Retrieves webhook configuration. Returns webhook details including URL, events, and status.

​
Authentication

This endpoint requires authentication via Bearer token:
  • Authorization: Bearer <token>

​
Path Parameters

ParameterTypeRequiredDescription
organizationIdstring (UUID)YesOrganization ID
idstring (UUID)YesWebhook ID

​
Response

Returns webhook configuration with:
  • Webhook ID, URL, and active status
  • Subscribed events
  • Creation and update timestamps

​
Example Request

curl -X GET http://localhost:3001/api/organizations/550e8400-e29b-41d4-a716-446655440000/webhooks/123e4567-e89b-12d3-a456-426614174000 \
  -H "Authorization: Bearer <your_token>"

​
Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000",
  "url": "https://example.com/webhooks",
  "events": ["organization.created", "member.added"],
  "isActive": true,
  "createdAt": "2025-01-26T10:00:00Z",
  "updatedAt": "2025-01-26T10:00:00Z"
}

​
Common Errors

​
401 Unauthorized

Authentication required. 
{
  "statusCode": 401,
  "message": "Authentication required. Provide a valid bearer token."
}

​
403 Forbidden

User is not a member of this organization. 
{
  "statusCode": 403,
  "message": "Access denied. User is not a member of this organization."
}

​
404 Not Found

Webhook not found. 
{
  "statusCode": 404,
  "message": "Webhook not found with the provided ID."
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string
required
​
id
string
required

Response

Webhook retrieved successfully with configuration details.