Webhook

A Webhook is a URL on your server that Loby sends webhook events to, for the event types it lists. It belongs to your museum and has the mode (live or test) of the API key that created it.

PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Unique identifier"9b2e4c6a-1d3f-4a5b-8c7d-0e1f2a3b4c5d"
createdAtstringTimestamp when the webhook was created"2026-11-03T09:00:00.000Z"
updatedAtstringTimestamp when the webhook was last updated"2026-11-03T09:00:00.000Z"
url*stringWhere Loby sends webhook events: a public https URL with a host name, at most 2048 characters"https://example.com/loby/webhooks"
eventTypes*array of stringThe event types the webhook receives["membership.created", "membership.updated"]
descriptionstringnullYour own note on what the webhook is for"CRM sync"
enabledbooleantrueWhether Loby sends webhook events to ittrue
secretstringThe signing secret. Only in the response to Create Webhook"whsec_EMI9soWck0iMI4fwI5p0TKobgZnsWf4yt1sGDJwQ6Xg="
Copy
{ "id": "9b2e4c6a-1d3f-4a5b-8c7d-0e1f2a3b4c5d", "createdAt": "2026-11-03T09:00:00.000Z", "updatedAt": "2026-11-03T09:00:00.000Z", "url": "https://example.com/loby/webhooks", "eventTypes": ["membership.created", "membership.updated", "membership.deleted"], "description": "CRM sync", "enabled": true }
‹ Previous
Visit
Next ›
Get Schema