Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

Your API key, sent bare. See Authentication.

Body

application/json
workspace_id
string
required

The workspace whose events it receives. A wks_ id; integer workspace ids are still accepted.

Example:

"wks_01k6a2r9s8x7c2dvq3m5n6p4ab"

url
string
required

A public HTTPS URL. Redirects are not followed.

Maximum string length: 2048
Example:

"https://api.acme.com/meetingkit/webhooks"

enabled_events
string[]
required

Event types, or * for every event this workspace and version send, now and later.

Minimum array length: 1
Example:
metadata

Merged into the object's metadata: the keys you send are added or overwritten and the others kept. "" as a value removes that key; metadata: "" removes every key. Numbers and booleans are stored as their text; objects, arrays and null are refused.

Example:
name
string | null

Defaults to the URL's host.

Maximum string length: 100
secret
string | null

Your own signing secret, at least 16 characters. Omit it to have one generated.

Maximum string length: 255
api_version
string

Pin the endpoint to this version instead of the one serving the request.

Example:

"2026-10-09"

Response

Endpoint created, with its secret.

secret
string
required

The signing secret. Shown only in this response.

Example:

"whsec_5f0c2a9e1b7d4c3a8e6f0b2d9c1a7e4f3b8d6c0a2e9f1b4d"

id
string

Webhook endpoint ID, beginning with whe_. Treat it as an opaque string.

Example:

"whe_01k6d4a1b2c3d4e5f6g7h8j9km"

object
string

Always webhook_endpoint.

workspace_id
string

Workspace ID, beginning with wks_. Treat it as an opaque string.

Example:

"wks_01k6a2r9s8x7c2dvq3m5n6p4ab"

name
string

Defaults to the URL's host.

Example:

"Acme production"

url
string<uri>

The public HTTPS URL events are sent to.

Example:

"https://api.acme.com/meetingkit/webhooks"

enabled_events
string[]

The events it receives, named as its api_version names them. * is every event.

Example:
status
enum<string>

Whether it receives events.

  • enabled: receives events.
  • disabled: receives nothing; disabling cancels its pending deliveries.
Available options:
enabled,
disabled
api_version
string<date>

The version its events are named and shaped at.

Example:

"2026-10-09"

metadata
object

Your own key-value pairs, for your ids and context. MeetingKit stores them, returns them on the object and in every webhook that carries it, and never acts on them. Up to 50 keys of up to 40 characters (no square brackets), values up to 500 characters. See metadata.

Example:
created_at
string<date-time>

When it was created, in ISO 8601.

updated_at
string<date-time>

When it last changed, in ISO 8601.