Events

List events

List events for your organization, or pass program_id and idempotency_key together to get the one event ingested under that key.

get/v1/events

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/events
  • Auth: HTTP bearer

Query parameters

limitinteger

Return at most this many records, from 1 to 200, default 50.

cursorstring

The next_cursor from the previous response, valid only with the same endpoint and filters.

program_idstring uuid

Filter by program ID

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED'

Filter by event status

event_type'EXTERNAL' | 'SYSTEM'

Filter by event type

participant_idstring uuid

Filter by participant ID

idempotency_keystring

Return the event ingested with this idempotency key; requires program_id, because keys are unique within a program

external_idstring

Filter by external ID

created_afterstring date-time

Return only records created after this time, RFC 3339.

created_beforestring date-time

Return only records created before this time, RFC 3339.

occurred_afterstring date-time

Return only events with an event_timestamp after this time, RFC 3339.

occurred_beforestring date-time

Return only events with an event_timestamp before this time, RFC 3339.

sort_by'created_at' | 'event_timestamp' | 'status'

Sort field

rule_idstring uuid

Filter by rule ID (events where rule matched)

sort_dir'asc' | 'desc'

Sort direction: asc or desc (default)

Response

List of events with payloads

Example response

{
  "data": [
    {
      "created_at": "2027-01-15T10:30:00Z",
      "error_code": "program_not_found",
      "error_message": "rule condition evaluation failed",
      "event_data": {
        "amount": 120,
        "type": "purchase"
      },
      "event_timestamp": "2027-01-15T10:30:00Z",
      "event_type": "EXTERNAL",
      "external_id": "user_123",
      "id": "e5dc1b6a-7f3d-4e2a-8c1b-9a0f4d7e6c05",
      "idempotency_key": "order-1001-completed",
      "participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b006",
      "processed_at": "2027-01-15T10:30:00Z",
      "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
      "received_at": "2027-01-15T10:30:00Z",
      "recipient_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b007",
      "status": "COMPLETED",
      "updated_at": "2027-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.