Skip to the content

Read a Trigger event

GET /v1/trigger-events/{trigger_event_id}

Property	Value
Operation	`get_trigger_event`
Group	Triggers
Scope	`integrations:read`
Route class	`read`
Idempotency	No `Idempotency-Key`
Audit	Not audited: A configuration read; a subscription and a stored Trigger event hold identifiers only.
Released in	1.61.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Answers one stored Trigger event, identifiers only (1.61.0), as the list answers it.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the integrations:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/trigger-events/tev_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/trigger-events/tev_...`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/trigger-events/tev_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`trigger_event_id`	path	TriggerEventId	yes	The id of a Trigger event: `tev_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	TriggerEvent
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`
`404`	`application/json`	ErrorEnvelope	`not_found`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is TriggerEvent.

Field	Type	Required	Description
`action_type`	TriggerActionType	yes
`call_id`	CallId or null	yes
`connection_id`	ConnectionId	yes
`connector_id`	ConnectorId	yes
`created_at`	Timestamp	yes
`dedupe_key`	KeyedHash	yes	The de-duplication key (1.60.0): from 1.64.0, stated, the `KeyedHash` under the Organization's run-log key over the canonical JSON of the object `{subscription_id, vendor_event_id}`, or of `{subscription_id, data}` with the normalized data when the vendor names no event id, so every edge of a cell computes one key and a rotated subscription token never changes it.
`environment`	Environment	yes
`error_code`	string or null	yes
`event_type`	TriggerEventTypeName	yes
`id`	TriggerEventId	yes
`job_id`	JobId or null	yes
`message_id`	MessageId or null	yes
`object`	`"trigger_event"`	yes
`organization_id`	OrganizationId	yes
`received_at`	Timestamp	yes
`replays`	integer	yes
`run_id`	RunId or null	yes
`status`	TriggerEventStatus	yes
`subscription_id`	TriggerSubscriptionId	yes
`vendor_event_id`	string or null	yes	The vendor's event id, or null.