Get batch callback delivery history

curl --request GET \
  --url https://api.runflow.io/v1/batches/{batch_id}/callback \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runflow.io/v1/batches/{batch_id}/callback', 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.runflow.io/v1/batches/{batch_id}/callback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.runflow.io/v1/batches/{batch_id}/callback"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.runflow.io/v1/batches/{batch_id}/callback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "callback_url": "<string>",
    "payload_bytes": "<string>",
    "payload": {
      "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "output": {},
      "duration_ms": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    },
    "signing_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_automatic": true,
    "status_code": "<string>",
    "failure_reason_code": "<string>",
    "failure_detail": "<string>",
    "attempt_count": 123,
    "max_attempts": 123,
    "next_attempt_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "attempts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "attempt_number": 123,
        "status_code": 123,
        "response_body": "<string>",
        "response_time_ms": 123,
        "error_message": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

GET

batches

{batch_id}

callback

Get batch callback delivery history

curl --request GET \
  --url https://api.runflow.io/v1/batches/{batch_id}/callback \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runflow.io/v1/batches/{batch_id}/callback', 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.runflow.io/v1/batches/{batch_id}/callback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.runflow.io/v1/batches/{batch_id}/callback"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.runflow.io/v1/batches/{batch_id}/callback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "callback_url": "<string>",
    "payload_bytes": "<string>",
    "payload": {
      "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "output": {},
      "duration_ms": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    },
    "signing_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_automatic": true,
    "status_code": "<string>",
    "failure_reason_code": "<string>",
    "failure_detail": "<string>",
    "attempt_count": 123,
    "max_attempts": 123,
    "next_attempt_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "attempts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "attempt_number": 123,
        "status_code": 123,
        "response_body": "<string>",
        "response_time_ms": 123,
        "error_message": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Organization-Id

string | null

Path Parameters

batch_id

string<uuid>

required

Response

Successful Response

string<uuid> | null

batch_id

string<uuid> | null

callback_url

string | null

payload_bytes

string | null

payload

BatchCallbackPayload · object | null

JSON payload delivered to a customer's callback_url when a batch reaches a terminal state.

Frozen at delivery time and stored as payload_bytes on the delivery row. Datetimes serialize via .isoformat() (+00:00 not Z) to preserve byte-equivalence for HMAC verification on the customer side.

Show child attributes

signing_secret_id

string<uuid> | null

is_automatic

boolean | null

status_code

string | null

failure_reason_code

string | null

failure_detail

string | null

attempt_count

integer | null

max_attempts

integer | null

next_attempt_at

string<date-time> | null

created_at

string<date-time> | null

updated_at

string<date-time> | null

completed_at

string<date-time> | null

attempts

FullValidator · object[] | null

Show child attributes

Reference

Additional surfaces

Get batch callback delivery history

Authorizations

Headers

Path Parameters

Response