Get webhook endpoint by ID

Request

Retrieve detailed information about a webhook endpoint.

Security

PartnerApiKey and PartnerOAuth

Path

webhookIdinteger, (int64)required

Webhook endpoint ID

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/webhook/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Webhook endpoint found and returned successfully

Bodyapplication/json

activeboolean

Whether this endpoint is active

Example:true

createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"

eventTypesArray of strings

Event types this endpoint is subscribed to

Example:

[
  "appointment.created",
  "appointment.updated",
  "form.completed"
]

idinteger, (int64)

Unique webhook endpoint identifier

Example:12345

lastFailureAtstring, (date-time)

UTC timestamp of the last failed outbound delivery for this endpoint. Null until the delivery worker records a failure.

Example:"2025-01-15T14:00:00Z"

lastSuccessAtstring, (date-time)

UTC timestamp of the last successful outbound delivery for this endpoint. Null until the delivery worker records a success.

Example:"2025-01-15T14:00:00Z"

namestring

Name for the endpoint

Example:"Production Webhook"

signingSecretstring

Signing secret — only returned on the create response, never on reads. Store it securely the moment it is returned; it cannot be retrieved later.

Example:"abc123XYZ..."

updatedAtstring, (date-time)

Last update timestamp (UTC)

Example:"2025-01-15T14:00:00Z"

urlstring

Webhook URL where events are delivered

Example:"https://api.example.com/webhooks/lobbie"

Response

{
  "active": true,
  "createdAt": "2025-01-15T14:00:00Z",
  "eventTypes": [
    "appointment.created",
    "appointment.updated",
    "form.completed"
  ],
  "id": 12345,
  "lastFailureAt": "2025-01-15T14:00:00Z",
  "lastSuccessAt": "2025-01-15T14:00:00Z",
  "name": "Production Webhook",
  "signingSecret": "abc123XYZ...",
  "updatedAt": "2025-01-15T14:00:00Z",
  "url": "https://api.example.com/webhooks/lobbie"
}