Batch Webhook Notification Payload
curl --request POST \
--url https://api.example.com/webhooks/example-batch \
--header 'Content-Type: application/json' \
--data '
{
"event_id": "<string>",
"info": {
"agent_id": "<string>",
"agent_name": "<string>",
"batch_id": "<string>",
"batch_name": "<string>",
"batch_url": "<string>",
"payload": {
"item_count": 123
}
},
"timestamp": "2023-11-07T05:31:56Z",
"type": "execution_batch"
}
'import requests
url = "https://api.example.com/webhooks/example-batch"
payload = {
"event_id": "<string>",
"info": {
"agent_id": "<string>",
"agent_name": "<string>",
"batch_id": "<string>",
"batch_name": "<string>",
"batch_url": "<string>",
"payload": { "item_count": 123 }
},
"timestamp": "2023-11-07T05:31:56Z",
"type": "execution_batch"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
event_id: '<string>',
info: {
agent_id: '<string>',
agent_name: '<string>',
batch_id: '<string>',
batch_name: '<string>',
batch_url: '<string>',
payload: {item_count: 123}
},
timestamp: '2023-11-07T05:31:56Z',
type: 'execution_batch'
})
};
fetch('https://api.example.com/webhooks/example-batch', 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.example.com/webhooks/example-batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'event_id' => '<string>',
'info' => [
'agent_id' => '<string>',
'agent_name' => '<string>',
'batch_id' => '<string>',
'batch_name' => '<string>',
'batch_url' => '<string>',
'payload' => [
'item_count' => 123
]
],
'timestamp' => '2023-11-07T05:31:56Z',
'type' => 'execution_batch'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/webhooks/example-batch"
payload := strings.NewReader("{\n \"event_id\": \"<string>\",\n \"info\": {\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"batch_id\": \"<string>\",\n \"batch_name\": \"<string>\",\n \"batch_url\": \"<string>\",\n \"payload\": {\n \"item_count\": 123\n }\n },\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"type\": \"execution_batch\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/webhooks/example-batch")
.header("Content-Type", "application/json")
.body("{\n \"event_id\": \"<string>\",\n \"info\": {\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"batch_id\": \"<string>\",\n \"batch_name\": \"<string>\",\n \"batch_url\": \"<string>\",\n \"payload\": {\n \"item_count\": 123\n }\n },\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"type\": \"execution_batch\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/webhooks/example-batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_id\": \"<string>\",\n \"info\": {\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"batch_id\": \"<string>\",\n \"batch_name\": \"<string>\",\n \"batch_url\": \"<string>\",\n \"payload\": {\n \"item_count\": 123\n }\n },\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"type\": \"execution_batch\"\n}"
response = http.request(request)
puts response.read_bodyAPI Reference
Batch Webhook Notification Payload
Example endpoint to expose the execution batch webhook notification schema. This operation is for documentation purposes only.
POST
/
webhooks
/
example-batch
Batch Webhook Notification Payload
curl --request POST \
--url https://api.example.com/webhooks/example-batch \
--header 'Content-Type: application/json' \
--data '
{
"event_id": "<string>",
"info": {
"agent_id": "<string>",
"agent_name": "<string>",
"batch_id": "<string>",
"batch_name": "<string>",
"batch_url": "<string>",
"payload": {
"item_count": 123
}
},
"timestamp": "2023-11-07T05:31:56Z",
"type": "execution_batch"
}
'import requests
url = "https://api.example.com/webhooks/example-batch"
payload = {
"event_id": "<string>",
"info": {
"agent_id": "<string>",
"agent_name": "<string>",
"batch_id": "<string>",
"batch_name": "<string>",
"batch_url": "<string>",
"payload": { "item_count": 123 }
},
"timestamp": "2023-11-07T05:31:56Z",
"type": "execution_batch"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
event_id: '<string>',
info: {
agent_id: '<string>',
agent_name: '<string>',
batch_id: '<string>',
batch_name: '<string>',
batch_url: '<string>',
payload: {item_count: 123}
},
timestamp: '2023-11-07T05:31:56Z',
type: 'execution_batch'
})
};
fetch('https://api.example.com/webhooks/example-batch', 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.example.com/webhooks/example-batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'event_id' => '<string>',
'info' => [
'agent_id' => '<string>',
'agent_name' => '<string>',
'batch_id' => '<string>',
'batch_name' => '<string>',
'batch_url' => '<string>',
'payload' => [
'item_count' => 123
]
],
'timestamp' => '2023-11-07T05:31:56Z',
'type' => 'execution_batch'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/webhooks/example-batch"
payload := strings.NewReader("{\n \"event_id\": \"<string>\",\n \"info\": {\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"batch_id\": \"<string>\",\n \"batch_name\": \"<string>\",\n \"batch_url\": \"<string>\",\n \"payload\": {\n \"item_count\": 123\n }\n },\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"type\": \"execution_batch\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/webhooks/example-batch")
.header("Content-Type", "application/json")
.body("{\n \"event_id\": \"<string>\",\n \"info\": {\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"batch_id\": \"<string>\",\n \"batch_name\": \"<string>\",\n \"batch_url\": \"<string>\",\n \"payload\": {\n \"item_count\": 123\n }\n },\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"type\": \"execution_batch\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/webhooks/example-batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_id\": \"<string>\",\n \"info\": {\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"batch_id\": \"<string>\",\n \"batch_name\": \"<string>\",\n \"batch_url\": \"<string>\",\n \"payload\": {\n \"item_count\": 123\n }\n },\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"type\": \"execution_batch\"\n}"
response = http.request(request)
puts response.read_bodyBody
application/json
Top-level V2 notification structure sent to webhook endpoints for execution batch events
Unique identifier for this notification event. Stable across redeliveries of the same event.
Batch-specific information about the event
Show child attributes
Show child attributes
Timestamp when the event occurred
The category of the notification. Always 'execution_batch' for batch events.
Available options:
execution_batch Response
204
There is no content to send for this request, but the headers may be useful.

