Read an event

GET /v1/events/{event_id}

Answers one event of the log by its id, as a delivery carried it, for 30 days (a target); an event of the other environment, or one pruned from the log, is not_found. From 1.62.0 a custom event's data in PHI mode is answered only to a read that names include=data, an audited content read (ADR 0051 rule 8); outside PHI mode the data is answered as delivered.

Request

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

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

const response = await fetch(`${process.env.VOCAL_API}/v1/events/evt_...`, {
  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/events/evt_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is Event.