Replay every delivery that did not arrive, by filter

curl --request POST \
  --url https://app.hookie.ai/admin/api/projects/{pid}/deliveries/replay \
  --header 'Content-Type: application/json' \
  --cookie hookie_session= \
  --data '
{
  "destination_id": "<string>",
  "status": [],
  "since": "2023-11-07T05:31:56Z",
  "until": "2023-11-07T05:31:56Z",
  "limit": 100,
  "dry_run": true
}
'

const options = {
  method: 'POST',
  headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination_id: '<string>',
    status: [],
    since: '2023-11-07T05:31:56Z',
    until: '2023-11-07T05:31:56Z',
    limit: 100,
    dry_run: true
  })
};

fetch('https://app.hookie.ai/admin/api/projects/{pid}/deliveries/replay', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.hookie.ai/admin/api/projects/{pid}/deliveries/replay"

payload = {
    "destination_id": "<string>",
    "status": [],
    "since": "2023-11-07T05:31:56Z",
    "until": "2023-11-07T05:31:56Z",
    "limit": 100,
    "dry_run": True
}
headers = {
    "cookie": "hookie_session=",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "queued": 123,
  "matched": 123,
  "remaining": 123,
  "more": true,
  "stopped": "delivery_allowance_exhausted",
  "error": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

Deliveries

Replay every delivery that did not arrive, by filter

Top-level alias: POST /admin/api/deliveries/replay. Write role required. The recovery after a receiver outage: replays every delivery in the project that matches the filter and did not arrive - 'dead', or 'failed' with no retry scheduled (one still being retried is left to its retry). Only the latest delivery of each event to each destination matches (an event's original and a failed replay of it are one event, sent once), and only while the event is stored; deliveries to a deleted destination, or to a customer-portal destination whose portal no longer exposes the dataset, never match. Oldest first. Bounded per call: queues up to limit and reports how many still match, so call again while more is true; a replayed delivery stops matching, so repeating (or racing) a call never sends one twice. Each replay is a new delivery (event_id <record>#replay:<n>) charged to the monthly delivery allowance, like a single replay: the call queues as many as the allowance grants and stops there. Audited once per call as replay_deliveries.

POST

admin

api

projects

{pid}

deliveries

replay

Replay every delivery that did not arrive, by filter

curl --request POST \
  --url https://app.hookie.ai/admin/api/projects/{pid}/deliveries/replay \
  --header 'Content-Type: application/json' \
  --cookie hookie_session= \
  --data '
{
  "destination_id": "<string>",
  "status": [],
  "since": "2023-11-07T05:31:56Z",
  "until": "2023-11-07T05:31:56Z",
  "limit": 100,
  "dry_run": true
}
'

const options = {
  method: 'POST',
  headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination_id: '<string>',
    status: [],
    since: '2023-11-07T05:31:56Z',
    until: '2023-11-07T05:31:56Z',
    limit: 100,
    dry_run: true
  })
};

fetch('https://app.hookie.ai/admin/api/projects/{pid}/deliveries/replay', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.hookie.ai/admin/api/projects/{pid}/deliveries/replay"

payload = {
    "destination_id": "<string>",
    "status": [],
    "since": "2023-11-07T05:31:56Z",
    "until": "2023-11-07T05:31:56Z",
    "limit": 100,
    "dry_run": True
}
headers = {
    "cookie": "hookie_session=",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "queued": 123,
  "matched": 123,
  "remaining": 123,
  "more": true,
  "stopped": "delivery_allowance_exhausted",
  "error": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>"
}

Authorizations

hookie_session

string

required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

pid

string

required

Project id (UUID) belonging to the caller workspace.

Body

application/json

destination_id

string

Only deliveries to this destination.

status

dead, failed, or both (the default). A list, or a comma-separated string. Any other status is a 400.

Available options:

dead,

failed

since

string<date-time>

Only deliveries created at or after this time.

until

string<date-time>

Only deliveries created at or before this time.

limit

integer

default:100

The most to queue in this call.

Required range: 1 <= x <= 500

dry_run

boolean

Answer {matched, dry_run: true} without queueing or charging anything - what a confirmation states.

Response

One bounded pass (or, with dry_run, the count alone).

Option 1
Option 2

queued

integer

required

New deliveries queued by this call.

matched

integer

required

Deliveries matching the filter when the call began.

remaining

integer

required

Deliveries still matching after it.

boolean

required

remaining > 0: call again to continue.

stopped

enum<string>

Present when the allowance ran out part-way.

Available options:

delivery_allowance_exhausted

error

string

With stopped: the allowance message.

Get started

CLI

Guides

API reference

Replay every delivery that did not arrive, by filter

Authorizations

Path Parameters

Body

Response