Emit a customer event

POST /v1/events

Records a customer-emitted event of the family custom, source customer, and answers 202 with its id and targets (1.62.0); the relay delivers it as every record event is, and in PHI mode its data travels in no payload. With process the processes module records a Process event named by the custom type and writes its commands; with call_id the calls module appends custom.received to the Call. Data above 32 KiB (a target) is data_too_large and a Call of the other environment, or ended more than 24 hours ago, call_not_targetable (CustomEventIssueCode); an instance by id that ended is process_not_active, and an unknown one or Process not_found. At most 20 a second per key (a target).

Request

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

curl -X POST "$VOCAL_API/v1/events" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "type": "custom.payment.received" }'

const response = await fetch(`${process.env.VOCAL_API}/v1/events`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "type": "custom.payment.received"
  }),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/events",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "type": "custom.payment.received",
    },
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: CustomEventCreateRequest.

Responses

Fields of the 202 answer

The shape is CustomEvent.