Skip to content
PayloadPuffin.
Join the waitlist

Use the ID returned by the API to read or change a resource. Its prefix tells you which kind of resource it identifies:

TEXT
evt_01m4pa5v4wetwab7xhgrev2tag

Treat 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

PrefixResourceIn the public API
evt_EventPaths, query parameters and response fields
dlv_DeliveryPaths, query parameters and response fields
att_AttemptResponse fields
dst_DestinationPaths, query parameters and response fields
src_SourcePaths and response fields, including an event's sender
apk_API keyAn event's sender
usr_UserAn event's sender, for an event sent from the console

Invalid and unknown IDs

RequestResponse
An ID with the wrong prefix or shape400 validation_failed
A well-formed ID that doesn't exist in the key's app404 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/events after 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.