Matchai Docs

List eventsComing soon

Returns the events of the last 30 days for this connection, newest first — the same bodies webhooks deliver. Use it to catch up after downtime.

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

Coming soon. Returns the events of the last 30 days for this connection, newest first — the same bodies webhooks deliver. Use it to catch up after downtime.

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

Query Parameters

limit?integer

How many results per page.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor of the previous page. Cursors expire after 24 hours.

Lengthlength <= 512
type?string

Only this type.

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"
since?string

Only events after this time.

Formatdate-time

Response Body

One page of events.

application/json
  1. response

One page of results. Pass next_cursor as cursor to get the next page; it is null on the last page.

data*array<>
next_cursor*|

Cursor for the next page, or null when there are no more results.

Example Request
curl -X GET 'https://api.matchai.co/v1/events'
Example Response
{  "data": [    {      "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": {}      }    }  ],  "next_cursor": "string"}