GET /v1/automation/events

GET/v1/automation/events

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

event_typestring

statusstring

limitinteger<int32>

min 1 · max 100 · default: 20

offsetinteger<int32>

min 0 · default: 0

Responses

200OK

itemsEventItem[] | nullrequired

Show properties

Array of EventItem

channel_idstring

contact_idstring

conversation_idstring

created_atstringrequired

dedupe_keystringrequired

entity_idstring

entity_typestring

event_typestringrequired

idstringrequired

matched_atstring

occurred_atstringrequired

payloadany

metaPaginationMeta

Show properties

cursorstring

has_morebooleanrequired

limitinteger<int64>required

next_cursorstring

offsetinteger<int64>

totalinteger<int64>

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/automation/events"

const response = await fetch("/v1/automation/events", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/automation/events",
)

Response

{
  "items": [
    {
      "channel_id": "string",
      "contact_id": "string",
      "conversation_id": "string",
      "created_at": "string",
      "dedupe_key": "string",
      "entity_id": "string",
      "entity_type": "string",
      "event_type": "string",
      "id": "string",
      "matched_at": "string",
      "occurred_at": "string",
      "payload": "string"
    }
  ],
  "meta": {
    "cursor": "string",
    "has_more": true,
    "limit": 0,
    "next_cursor": "string",
    "offset": 0,
    "total": 0
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}