PSpscrpt
events

Bulk create events

Changed on

Accepts up to 1,000 events. external_id and shopify_customer_id must already match a profile. Items are validated per the event catalog. See Bulk requests for per-item results and retry behaviour.

post/events/batch

Request

  • Base URL
    https://api.pscrpt.com/v1
  • URL
    https://api.pscrpt.com/v1/events/batch
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.pscrpt.com/oauth/authorize
      Token URL: https://api.pscrpt.com/oauth/token scopes: events:write

Headers

Idempotency-Keystring

Deduplicates retries for 24 hours: the same key returns the original response with Idempotency-Replayed: true; the same key with a different body returns 409 idempotency_key_reused.

Postscript-Versionstring date
Example:2026-07-23

Overrides the key's pinned API revision for this request.

Request body

backfillboolean

Marks the whole batch as historical: stored and counted in aggregates, but never triggers flows or webhooks. Debits a separate rate window. Where the historical lane is available the batch is queued and the response is 202, with accepted items reporting status 202; events are readable once promoted, typically within 15 minutes.

Example request

{
  "events": [
    {
      "identifier": {
        "type": "email"
      }
    }
  ]
}

Response

Per-item results in request order. Failed items carry a per-item error; successes carry the event reference.

Changes

  • c0c9a9f0ac5cRevision changes
    • info

      added the success response with the status

  • e30a64c93065Revision changes
    • breaking

      removed the required property // from the response with the status

    • info

      removed subschema #1 from the / response property allOf list for the response status

    • info

      the response property // became required for the status