MailcrateDocs
Events

List contact events

GET
/public/event

Requires the event:read scope.

Authorization

ApiKey
headerAuthorization<token>

Api-Key mc_... — a workspace API key.

Query Parameters

contact*string
name?string
Match^[a-zA-Z0-9][a-zA-Z0-9 ._-]*$
Lengthlength <= 100
contactId?string
Formatuuid
limit?integer
Range1 <= value <= 500
Default50
offset?integer
Range0 <= value
Default0
page?integer
Range1 <= value
sortBy?string
sortOrder?string
Value in"ASC""DESC"

Response Body

A page of results.

application/json
  1. response
data*array<>
total*integer

Matches across all pages.

limit*integer
offset*integer

The offset actually applied, also when you paginated with page.

Example Request
curl -X GET 'https://api.mailcrate.io/public/event?contact=string' \  -H 'Authorization: Api-Key <api_key>'
Example Response
{  "data": [    {      "id": "string",      "name": "string",      "contactId": "string",      "properties": {},      "occurredAt": "2019-08-24T14:15:22Z",      "created": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "limit": 0,  "offset": 0}

Update an email template PUT

Requires the `email-template:write` scope.

Record a contact event POST

Records a custom event against a contact, which segments and journey triggers can match on. Identify the contact by `contactId`, `email` or `externalIdentifier`. Requires the `event:write` scope.