Use the ID returned by the API to read or change a resource. Its prefix tells you which kind of resource it identifies:
evt_01m4pa5v4wetwab7xhgrev2tagTreat the part after the prefix as an opaque string. Store the whole ID as the API returned it, and send it back unchanged. IDs are case-sensitive, so an uppercase copy doesn't match.
Prefixes
| Prefix | Resource | In the public API |
|---|---|---|
evt_ | Event | Paths, query parameters and response fields |
dlv_ | Delivery | Paths, query parameters and response fields |
att_ | Attempt | Response fields |
dst_ | Destination | Paths, query parameters and response fields |
src_ | Source | Paths and response fields, including an event's sender |
apk_ | API key | An event's sender |
usr_ | User | An event's sender, for an event sent from the console |
Invalid and unknown IDs
| Request | Response |
|---|---|
| An ID with the wrong prefix or shape | 400 validation_failed |
| A well-formed ID that doesn't exist in the key's app | 404 not_found |
An ID that exists in another app returns 404, the same as an ID that doesn't exist.
Ordering
List operations return the newest items first, and a list's cursor is an ID. That order isn't a strict chronology:
- Two resources created at nearly the same moment can be listed in either order.
- An event can appear in
GET /v1/eventsafter events that were accepted later. - List order says nothing about the order in which deliveries reach a destination.
receivedAt on an event is the time PayloadPuffin accepted it. Pagination with IDs as cursors is described in Pagination.