Create webhook endpoint

Request

Create a new webhook endpoint to receive event notifications. Specify the URL and the event types you want to subscribe to. A signing secret will be generated and returned - store it securely.

Security

PartnerApiKey and PartnerOAuth

Bodyapplication/jsonrequired

activeboolean

Whether deliveries are enabled. Defaults to true if omitted.

Example:true

eventTypesArray of stringsrequired

Event types to subscribe to. Must be non-empty and every value must match a known event type returned by GET /event-types.

Example:

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

namestring

Name for the endpoint

Example:"Production Webhook"

urlstringrequired

Webhook URL. Must be HTTPS and include a host.

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

curl -i -X POST \
  https://api-docs.lobbie.com/_mock/openapi/partner/v2/webhook \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "active": true,
    "eventTypes": [
      "appointment.created",
      "appointment.updated",
      "form.completed"
    ],
    "name": "Production Webhook",
    "url": "https://api.example.com/webhooks/lobbie"
  }'

Responses

Webhook endpoint created 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"
}