curl --request GET \
--url https://api.scrip.dev/v1/events/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.scrip.dev/v1/events/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.scrip.dev/v1/events/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrip.dev/v1/events/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scrip.dev/v1/events/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/events/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrip.dev/v1/events/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"created_at": "2024-01-15T10:30:00Z",
"error_code": "program_not_found",
"error_message": "rule condition evaluation failed",
"event_data": {},
"event_timestamp": "2024-01-15T10:30:00Z",
"event_type": "EXTERNAL",
"external_id": "user_abc123",
"id": "550e8400-e29b-41d4-a716-446655440000",
"idempotency_key": "order-12345-completed",
"participant_id": "550e8400-e29b-41d4-a716-446655440002",
"processed_at": "2024-01-15T10:30:02Z",
"program_id": "550e8400-e29b-41d4-a716-446655440001",
"received_at": "2024-01-15T10:30:01Z",
"recipient_id": "550e8400-e29b-41d4-a716-446655440003",
"rule_evaluations": [
{
"created_at": "2024-01-15T10:30:00Z",
"error_message": "condition evaluation failed",
"id": "550e8400-e29b-41d4-a716-446655440000",
"reason": "OUTSIDE_TIME_WINDOW",
"rule_history_id": "550e8400-e29b-41d4-a716-446655440003",
"rule_id": "550e8400-e29b-41d4-a716-446655440001",
"rule_name": "Welcome Bonus",
"rule_set_id": "550e8400-e29b-41d4-a716-446655440004",
"status": "SUCCESS",
"stopped_by_rule_id": "550e8400-e29b-41d4-a716-446655440002"
}
],
"status": "COMPLETED",
"updated_at": "2024-01-15T10:30:00Z"
}{
"code": "bad_request",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Invalid request parameters"
}{
"code": "unauthorized",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Missing or invalid credentials"
}{
"code": "forbidden",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Insufficient permissions for this action"
}{
"code": "not_found",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Resource not found"
}{
"code": "internal_error",
"message": "An internal error occurred"
}Get an event
Retrieve a single event by ID, including processing status and rule evaluation results.
curl --request GET \
--url https://api.scrip.dev/v1/events/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.scrip.dev/v1/events/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.scrip.dev/v1/events/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrip.dev/v1/events/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scrip.dev/v1/events/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/events/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrip.dev/v1/events/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"created_at": "2024-01-15T10:30:00Z",
"error_code": "program_not_found",
"error_message": "rule condition evaluation failed",
"event_data": {},
"event_timestamp": "2024-01-15T10:30:00Z",
"event_type": "EXTERNAL",
"external_id": "user_abc123",
"id": "550e8400-e29b-41d4-a716-446655440000",
"idempotency_key": "order-12345-completed",
"participant_id": "550e8400-e29b-41d4-a716-446655440002",
"processed_at": "2024-01-15T10:30:02Z",
"program_id": "550e8400-e29b-41d4-a716-446655440001",
"received_at": "2024-01-15T10:30:01Z",
"recipient_id": "550e8400-e29b-41d4-a716-446655440003",
"rule_evaluations": [
{
"created_at": "2024-01-15T10:30:00Z",
"error_message": "condition evaluation failed",
"id": "550e8400-e29b-41d4-a716-446655440000",
"reason": "OUTSIDE_TIME_WINDOW",
"rule_history_id": "550e8400-e29b-41d4-a716-446655440003",
"rule_id": "550e8400-e29b-41d4-a716-446655440001",
"rule_name": "Welcome Bonus",
"rule_set_id": "550e8400-e29b-41d4-a716-446655440004",
"status": "SUCCESS",
"stopped_by_rule_id": "550e8400-e29b-41d4-a716-446655440002"
}
],
"status": "COMPLETED",
"updated_at": "2024-01-15T10:30:00Z"
}{
"code": "bad_request",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Invalid request parameters"
}{
"code": "unauthorized",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Missing or invalid credentials"
}{
"code": "forbidden",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Insufficient permissions for this action"
}{
"code": "not_found",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Resource not found"
}{
"code": "internal_error",
"message": "An internal error occurred"
}status, recorded rule-evaluation outcomes, and error details if the event failed.
rule_evaluations shows recorded rule results in the order they ran. Each row includes the rule_set_id used for that event and a rule_history_id identifying the rule version.
A condition that evaluates to false produces no row. After a matching rule executes successfully with stop_after_match: true, later rules in that same set are not reached and produce no row. Processing continues with the next rule set. For failed events, error_message contains the failure reason, and error_code carries a machine-readable code when the failure has one, such as participant_suspended.
Events are accepted asynchronously, so a freshly-returned ID may 404 briefly (typically well under a second) while the event is still queued. Poll until it resolves; the ID is durable. The same visibility window applies to the by-key lookup. An event that was rejected during async processing resolves here as status FAILED with an error_code, not as a 404.
Pass include_skipped=true to include SKIPPED_ERROR and SKIPPED_TIMEOUT results, which are hidden by default. This does not add rows for false conditions or rules that never ran.
SKIPPED results are always included. Their reason explains what happened:
| Reason | Meaning |
|---|---|
OUTSIDE_TIME_WINDOW | The event’s timestamp is outside the rule’s active window. |
BUDGET_EXCEEDED | The credit would exceed the rule’s program-wide budget. |
PARTICIPANT_BUDGET_EXCEEDED | The credit would exceed the recipient’s budget. error_message gives their usage, the refused amount, and the next reset when one is scheduled. |
SHARED_STATE_CHANGED | Shared program or group state changed, and the rule could no longer run. error_message names the key and its values when read and when the update was attempted. |
Authorizations
API key passed in the X-API-Key header.
Path Parameters
Event ID
Query Parameters
Include skipped rule evaluations (SKIPPED_ERROR, SKIPPED_TIMEOUT)
Response
Event details with rule executions
When this event was created
"2024-01-15T10:30:00Z"
Machine-readable failure code for a terminal FAILED event, when one is available (e.g. program_not_found, participant_suspended, participant_inactive). NULL when the event did not fail or the failure carried no stable code.
"program_not_found"
Error details if the event failed during processing
"rule condition evaluation failed"
Original event data payload
When the event occurred (from the ingestion request)
"2024-01-15T10:30:00Z"
Event type: EXTERNAL (API-ingested) or SYSTEM (internally generated)
"EXTERNAL"
Your system's identifier for the participant (the value provided at ingestion)
"user_abc123"
Unique identifier for this event
"550e8400-e29b-41d4-a716-446655440000"
Client-provided unique key for deduplication
"order-12345-completed"
Participant UUID, resolved from external_id if one was provided at ingestion
"550e8400-e29b-41d4-a716-446655440002"
When the event finished processing (null while pending or processing)
"2024-01-15T10:30:02Z"
Program this event belongs to
"550e8400-e29b-41d4-a716-446655440001"
When Scrip received the event
"2024-01-15T10:30:01Z"
Recipient participant UUID sent as recipient_id or recipient_external_id; rules read it as recipient.id
"550e8400-e29b-41d4-a716-446655440003"
Recorded rule-evaluation rows for this event. Rules whose conditions cleanly evaluate to false are not recorded; later rules in the same set after a successful stop_after_match are not evaluated or recorded. SKIPPED_ERROR and SKIPPED_TIMEOUT rows are omitted unless include_skipped=true.
Show child attributes
Show child attributes
Processing status: PENDING, PROCESSING, COMPLETED, or FAILED
"COMPLETED"
When this event was last updated
"2024-01-15T10:30:00Z"