Skip to content
PayloadPuffin.
Join the waitlist

Each term has one meaning across these docs, and links to the page that explains it.

Accepted. A request is accepted when POST /v1/events or a source returns 202. PayloadPuffin has stored it; no destination has necessarily received it yet.

API key. A secret that authorizes requests to one app, sent as a Bearer token and limited by its scopes.

App. One environment, such as staging or production, with its own API keys, sources, destinations, events and deliveries.

Attempt. One HTTP request that PayloadPuffin sends to a destination for a delivery.

Channel. A slug such as initech that addresses events inside an app, typically one per customer.

Cursor. The ID in a list's links.next that marks where the next page starts.

Delivered. A delivery is delivered when an attempt got a 2xx response from the destination.

Delivery. One event owed to one destination, retried as a unit until it is delivered or fails.

Delivery policy. A destination's limits on requests in flight and requests per second.

Destination. A receiver you configure: its URL, two filters, a signing secret and delivery settings. The filters, on event type and channel, decide which events it receives.

Error code. The stable code member of an error response, such as validation_failed.

Event. Something that happened in your product, sent to PayloadPuffin with a type and a payload.

Event type. The name in an event's type field that you choose, such as customer.created.

Idempotency key. The value of the Idempotency-Key header, which makes a repeated POST /v1/events return the first receipt for 24 hours.

Organization. Your company's account with PayloadPuffin, which owns apps, members and the plan.

Recording. The stored copy of the request an attempt sent and the response it got.

Resend. A request for one more attempt on an existing delivery.

Resource ID. A prefixed identifier such as evt_01m4pa5v4wetwab7xhgrev2tag.

Retention. The number of days an organization's event data is kept.

Retry. An automatic attempt that PayloadPuffin schedules after a failed attempt of the same delivery.

Scope. A permission on an API key, such as events:write, that each operation requires.

Signing secret. A destination's secret that PayloadPuffin signs each webhook with, so the receiver can check where it came from.

Source. A URL you give another service, such as a payment provider, so it can send webhooks to PayloadPuffin. Each accepted request is stored and used to build an event.

Transform. JavaScript that builds an event from a source's request or rewrites the request sent to a destination. It belongs to the app, and any number of sources or destinations of its kind can link it.

Unbuilt. A source stored the request but couldn't build an event from it; unbuiltReason explains why, and no deliveries exist yet.

Unmatched. A built event matched no enabled destination, so it has no deliveries.