Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

Workspace API key (lora_sk_…) sent as Authorization: Bearer <api_key>. Each scoped operation names the scope it requires in its security requirement, for example shortcuts.write; a key without it receives 403 with code: insufficient_scope. GET /v1/qr also accepts anonymous requests and requires no scope.

Scopes

webhooks.write

Headers

Idempotency-Key
string

A unique value for this request, up to 255 characters, to make retrying it safe. Remembered for 24 hours per workspace and API key.

Maximum string length: 255

Body

application/json

Payload to create a webhook endpoint.

events
enum<string>[]
required

The events the endpoint receives. An endpoint gets only events created after it was created, or after the event was added to this list: nothing is sent for the past.

Required array length: 1 - 3 elements

An event type. shortcut.created: a visible shortcut was inserted, or a shortcut became visible to the workspace. shortcut.updated: a shortcut was updated. shortcut.deleted: a shortcut was removed, or left workspace visibility (made private or unlisted).

Available options:
shortcut.created,
shortcut.updated,
shortcut.deleted
url
string
required

The HTTPS URL that receives events. It must resolve to a public address: IP addresses, local names and private, loopback and link-local ranges are refused, and redirects are not followed. Each URL can be an endpoint once per workspace.

Required string length: 1 - 2048
Example:

"https://example.com/hooks/lora"

description
string | null

A label for the endpoint, up to 200 characters. It appears in the emails Lora sends about the endpoint.

Maximum string length: 200
Example:

"Sync to the intranet"

Response

A retry of a request that already created an endpoint: that endpoint, without its secret.

The endpoint an earlier request with the same Idempotency-Key created. It carries no secret: rotate the secret if it was lost.

createdAt
string<date-time>
required

ISO 8601 creation time.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
description
string | null
required

The endpoint's label, or null when it has none.

disabledReason
enum<string> | null
required

Why the endpoint is off, or null while it is on. manual: someone turned it off. gone: the receiver answered 410 Gone. failing: for five days no delivery succeeded, and at least five deliveries ran out of retries.

Available options:
manual,
gone,
failing,
null
enabled
boolean
required

Whether events are delivered. Turning an endpoint off cancels the deliveries still waiting for it.

events
enum<string>[]
required

The events the endpoint receives.

An event type. shortcut.created: a visible shortcut was inserted, or a shortcut became visible to the workspace. shortcut.updated: a shortcut was updated. shortcut.deleted: a shortcut was removed, or left workspace visibility (made private or unlisted).

Available options:
shortcut.created,
shortcut.updated,
shortcut.deleted
id
string
required

The endpoint's unique ID.

Pattern: ^wh_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"wh_0198f2a4-7c1b-7d3e-9a52-3f6b1c2d4e5f"

previousSecretExpiresAt
string<date-time> | null
required

While a rotated secret still signs next to the new one, when it stops, ISO 8601; otherwise null.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
source
enum<string>
required

api: created with an API key. subscription: made by an integration such as Zapier, which owns it. You can read it here; only the integration changes or deletes it.

Available options:
api,
subscription
updatedAt
string<date-time>
required

ISO 8601 time of the last change.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
url
string
required

The URL that receives events. For an endpoint an integration made (source: subscription), only the host is shown.