All pages

API reference

List events

GET /v1/events

View as Markdown

Every event sent to webhook receivers in the last 30 days, oldest first, whether or not any receiver heard it — each with the id its deliveries carry. Keep the last page's next_cursor and ask again later for what happened since. Events from the last minute wait for the next page. conversation.transcript events also need transcripts:read. Needs conversations:read.

Parameters

Name In Type Required Description
type query array of string or null No An event type, like conversation.ended. Repeatable.
conversation_id query string (uuid) or null No Only the events about this conversation.
created_after query string (date-time) or null No Only events from this time on.
limit query integer No How many to return, 1 to 100.
cursor query string or null No next_cursor from the previous page, with the same filters.

Answer

200 with EventList.

Errors

Every error is a problem document with a stable code.

Status When
401 The key is missing, mistyped, unknown, revoked or expired.
403 The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
422 Validation Error
429 Too many requests for this key or its organization; see Retry-After.
500 Something went wrong on our side. Quote the request_id to support.

Examples

Read the event feed
#!/bin/sh
# Read the event feed. Keep the last page's next_cursor and send it back as cursor= next time.
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/events?type=conversation.ended&limit=50" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.