Project API reference
Integrate your application using project-scoped endpoints, events, deliveries, and credentials.
The project API operates on an existing project. Create your account, organization, and project in the dashboard before using these endpoints.
Before your first request
Read authentication and project identity, then errors and pagination. Every request goes to the Go API origin, which may differ from this documentation site's address.
Resources
Publish an event
Accept an event and fan out to matching endpoints.
Register an endpoint
Connect an HTTPS receiver and its event subscriptions.
Inspect deliveries
Follow delivery state and retry scheduling.
Check project identity
Confirm the project authorized by your API key.
| Resource | Purpose |
|---|---|
| Project | Inspect credential project identity and suspension state |
| Endpoints | Register receivers, manage subscriptions, configure secrets, verify ownership |
| Events | Publish and inspect accepted events |
| Deliveries | Inspect states, attempts, and replay cycles |
| API keys | Create, inspect, rotate, and revoke project credentials |
Expand the resource groups in the sidebar for generated request and response documentation. GET operations also support HEAD as described by the schema.
OpenAPI
The reference is generated from the same contract served at
/openapi.json. Its API server address comes from the docs
deployment configuration. If that address is unavailable, the downloadable
schema returns 503 rather than substituting the documentation host.
Code samples with YOUR_API_HOST or YOUR_PROJECT_API_KEY contain placeholders.
Replace them with your configured API origin and a locally stored project key.