Skip to documentation

API · Events

Retrieve Event

Retrieve an event definition by ID or name (requires full access).

GET/events/{id}Full access

Request parameters

ParameterTypeDescription
id
path · required
stringEvent id or name.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash
curl -X GET "$OPENSEND_BASE_URL/events/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json
{
  "object": "event",
  "id": "YOUR_ID",
  "name": "example",
  "schema": "example",
  "created_at": "example",
  "updated_at": "example"
}

Behavior and errors

Names beginning with opensend: are reserved. This manages custom event definitions, not webhook subscriptions.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.