Matchai Docs

Get an eventComing soon

Returns one event.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/events/{event_id}

Coming soon. Returns one event.

Scopes: webhooks:manage

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: webhooks:manage

Path Parameters

event_id*string

Event id.

Length1 <= length <= 64

Response Body

The event.

application/json
  1. response

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*EventType

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*
Example Request
curl -X GET 'https://api.matchai.co/v1/events/string'
Example Response
{  "id": "string",  "type": "lead.created",  "created_at": "2019-08-24T14:15:22Z",  "api_version": "v1",  "test_mode": true,  "account": {    "user_id": "string",    "professional_id": "string"  },  "data": {    "object": {},    "previous": {}  }}