Create Webhook

Register an HTTPS endpoint for the events you choose. Lodgestory POSTs a signed JSON envelope to it for every matching event — the Webhooks API reference has the envelope, the X-Webhook-Signature check, retries and every event's payload.

The response carries the endpoint's signing secret. No other API response returns it, so store it now (admins can also see it in Settings → Webhooks).

An organisation can have up to 30 endpoints, counting the ones created in Settings → Webhooks. Automation platforms register one endpoint per workflow: for a Zapier REST Hook trigger, call this from the subscribe step with url = bundle.targetUrl, keep the returned webhookId, and delete it from the unsubscribe step.

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

Body Params
string
required

HTTPS endpoint that will receive the webhooks

events
array of strings
required

Event types to subscribe to

events*
string

Human-friendly label

headers
object

Extra static headers to send with each delivery

Responses

400

Bad request — invalid URL (it must be publicly reachable and must not point at the Lodgestory API), an unknown event or field, or the organisation already has 30 endpoints

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — role not permitted

429

Too many requests

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json