cURL
curl --request GET \
--url https://api.example.com/api/v2/webhooks/deliveries/{id}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v2/webhooks/deliveries/{id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v2/webhooks/deliveries/{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.example.com/api/v2/webhooks/deliveries/{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 => [
"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.example.com/api/v2/webhooks/deliveries/{id}/"
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))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v2/webhooks/deliveries/{id}/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/webhooks/deliveries/{id}/")
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{
"api_version": "<string>",
"attempt": 123,
"created_at": "2023-11-07T05:31:56Z",
"deferrals": 123,
"delivered_at": "2023-11-07T05:31:56Z",
"endpoint": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"error": "<string>",
"event_id": "<string>",
"event_type": "<string>",
"failure_code": "invalid_input",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_retry_at": "2023-11-07T05:31:56Z",
"payload": "<unknown>",
"response_body": "<string>",
"response_status": 123,
"status": "pending",
"target_url": "<string>"
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}webhooks
Get apiv2webhooksdeliveries
Read-only delivery history + manual replay action.
Required scope: webhooks:read. A key without it is a 403 naming the scope; the endpoint is never silently skipped.
GET
/
api
/
v2
/
webhooks
/
deliveries
/
{id}
/
cURL
curl --request GET \
--url https://api.example.com/api/v2/webhooks/deliveries/{id}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v2/webhooks/deliveries/{id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v2/webhooks/deliveries/{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.example.com/api/v2/webhooks/deliveries/{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 => [
"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.example.com/api/v2/webhooks/deliveries/{id}/"
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))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v2/webhooks/deliveries/{id}/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/webhooks/deliveries/{id}/")
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{
"api_version": "<string>",
"attempt": 123,
"created_at": "2023-11-07T05:31:56Z",
"deferrals": 123,
"delivered_at": "2023-11-07T05:31:56Z",
"endpoint": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"error": "<string>",
"event_id": "<string>",
"event_type": "<string>",
"failure_code": "invalid_input",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_retry_at": "2023-11-07T05:31:56Z",
"payload": "<unknown>",
"response_body": "<string>",
"response_status": 123,
"status": "pending",
"target_url": "<string>"
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}Authorizations
CompanyApiKeyApplicationCredentialDashboardSession
A managed API key, sent as Authorization: Bearer <key>. A workspace key is prefixed tgcc_; a reseller key is prefixed tgpk_. Keys carry scopes; the scope each operation demands is on the operation as x-required-scope.
Path Parameters
A UUID string identifying this outbound webhook delivery.
Response
Full form for the detail endpoint - includes payload + response body so the manager can debug a failed delivery.
invalid_input- Receiver rejected the payloadprovider_unavailable- Receiver unavailableusage_blocked- Delivery not available on this plancancelled- Delivery cancelledinternal_error- Internal error
Available options:
invalid_input, provider_unavailable, usage_blocked, cancelled, internal_error pending- Pendingdelivered- Deliveredfailed- Failed
Available options:
pending, delivered, failed 
