POST/events

Ingest a single event

Requires Bearer authentication. See Authentication.

Request body

Field Type Description

eventTyperequired string —

occurredAtrequired string (date-time) —

payloadrequired object (record) —

metadata object (record) —

sourcerequired string —

customerExternalIdrequired string —

idempotencyKey string —

correlationId string —

requestId string —

attachments array —

AttachmentInline

sourcerequired FileSource —

kind = s3

`kind`required	"s3"	—
`uri`required	string	—

kind = gcs

`kind`required	"gcs"	—
`uri`required	string	—

fileTyperequired string —

contentType string —

sizeBytes integer | string —

Option 1 · integer

No fields.

Option 2 · string

No fields.

fileName string —

metadata object (record) —

AttachmentRef

fileIdrequired string (uuid) —

Responses

202 202

Field	Type	Description
`id`required	string (uuid)	—
`status`required	"accepted" \| "duplicate"	—

400 400

Field Type Description

errorrequired object —

`code`required	string	—
`message`required	string	—
`details`	any	—

401 401

Field Type Description

errorrequired object —

`code`required	string	—
`message`required	string	—
`details`	any	—

Errors

Errors use the standard envelope. See Errors for codes, status mappings, and retry semantics.

curl -X POST https://api.pushrail.io/events \ -H "Authorization: Bearer pk_live_..." \ -H "Content-Type: application/json" \ -d ' { "eventType": "string", "occurredAt": "2026-06-24T18:04:14.143Z", "payload": {}, "metadata": {}, "source": "string", "customerExternalId": "string", "idempotencyKey": "string", "correlationId": "string", "requestId": "string", "attachments": [ { "source": { "kind": "s3", "uri": "string" }, "fileType": "string", "contentType": "string", "sizeBytes": 0, "fileName": "string", "metadata": {} } ] }'