Matchai Docs

A visit or meeting was requestedComing soon

Event appointment.requested. Someone asked the account holder for a time. It waits for their answer.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.

Coming soon. Event appointment.requested. Someone asked the account holder for a time. It waits for their answer.

Verify Matchai-Signature before trusting the body, and answer with any 2xx within 10 seconds.

Scopes to receive it: calendar:read

Pricing: Included with the connection.

Header Parameters

Matchai-Signature*string

t=<unix seconds>,v1=<hex HMAC-SHA256>. During a secret rotation it carries two v1 values.

Matchai-Event-Id*string

Same as the body’s id. Use it to ignore duplicates.

Matchai-Delivery-Attempt*integer

Attempt number, from 1.

Range1 <= value

Request Body

application/json
  1. body

The body of every webhook delivery, and of GET /events.

id*string

Event id. Deliveries can repeat: use it to ignore duplicates.

Length1 <= length <= 64
type*string

New event types may be added. Ignore types you do not know.

Value in"lead.created""contact.created""contact.updated""contact.converted""contact.deleted""conversation.created""message.received""message.sent""appointment.requested""appointment.booked""appointment.rescheduled""appointment.cancelled""listing.created""listing.updated""listing.published""listing.unpublished""listing.archived""listing.deleted""listing.saved""listing.generation.completed""document.created""drop_link.upload_received""invitation.accepted""notification.created""approval.resolved""webhook.test"
created_at*string

When it happened.

Formatdate-time
api_version*string
test_mode*boolean

Sent for a test connection or by POST /webhook-subscriptions/{id}/test.

account*
data*

Response Body

Received. Any 2xx status works. Anything else, or no answer within 10 seconds, is retried.

Example Requests
POST/appointment.requested
Request Body
application/json
{  "id": "string",  "type": "lead.created",  "created_at": "2019-08-24T14:15:22Z",  "api_version": "v1",  "test_mode": true,  "account": {    "user_id": "string"  },  "data": {    "object": {}  }}
Header Parameters
{  "Matchai-Signature": "t=1760627565,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd",  "Matchai-Event-Id": "string",  "Matchai-Delivery-Attempt": 1}