Update a WebhookEndpoint
curl --request POST \
--url https://api.example.com/v1/webhook_endpoints/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"enabled_events": [
"<string>"
],
"description": "<string>",
"filters": {
"carriers": [
"<string>"
],
"connections": [
"<string>"
],
"user_metadata": {}
},
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/webhook_endpoints/{id}"
payload = {
"url": "<string>",
"enabled_events": ["<string>"],
"description": "<string>",
"filters": {
"carriers": ["<string>"],
"connections": ["<string>"],
"user_metadata": {}
},
"user_metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
enabled_events: ['<string>'],
description: '<string>',
filters: {carriers: ['<string>'], connections: ['<string>'], user_metadata: {}},
user_metadata: {}
})
};
fetch('https://api.example.com/v1/webhook_endpoints/{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/v1/webhook_endpoints/{id}",
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([
'url' => '<string>',
'enabled_events' => [
'<string>'
],
'description' => '<string>',
'filters' => [
'carriers' => [
'<string>'
],
'connections' => [
'<string>'
],
'user_metadata' => [
]
],
'user_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/v1/webhook_endpoints/{id}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"enabled_events\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"filters\": {\n \"carriers\": [\n \"<string>\"\n ],\n \"connections\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\n },\n \"user_metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/v1/webhook_endpoints/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"enabled_events\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"filters\": {\n \"carriers\": [\n \"<string>\"\n ],\n \"connections\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\n },\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/webhook_endpoints/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"enabled_events\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"filters\": {\n \"carriers\": [\n \"<string>\"\n ],\n \"connections\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\n },\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "we_1Q2w3E4r",
"object": "webhook_endpoint",
"livemode": true,
"created": 123,
"url": "<string>",
"enabled_events": [
"<string>"
],
"status": "enabled",
"updated": 123,
"description": "<string>",
"api_version": "<string>",
"filters": {
"carriers": [
"<string>"
],
"connections": [
"<string>"
],
"user_metadata": {}
},
"secret": "<string>",
"secret_preview": "<string>",
"disabled_reason": "<string>",
"delivery": {
"last_success_at": 123,
"last_failure_at": 123,
"failure_streak": 123
},
"user_metadata": {},
"carrier_metadata": {},
"system_metadata": {
"source": "api",
"created_by": {
"type": "api_key",
"id": "<string>"
},
"request_id": "<string>",
"idempotency_key": "<string>",
"batch": "<string>",
"generated": true,
"test_scenario": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}Webhooks
Update a WebhookEndpoint
POST
/
v1
/
webhook_endpoints
/
{id}
Update a WebhookEndpoint
curl --request POST \
--url https://api.example.com/v1/webhook_endpoints/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"enabled_events": [
"<string>"
],
"description": "<string>",
"filters": {
"carriers": [
"<string>"
],
"connections": [
"<string>"
],
"user_metadata": {}
},
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/webhook_endpoints/{id}"
payload = {
"url": "<string>",
"enabled_events": ["<string>"],
"description": "<string>",
"filters": {
"carriers": ["<string>"],
"connections": ["<string>"],
"user_metadata": {}
},
"user_metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
enabled_events: ['<string>'],
description: '<string>',
filters: {carriers: ['<string>'], connections: ['<string>'], user_metadata: {}},
user_metadata: {}
})
};
fetch('https://api.example.com/v1/webhook_endpoints/{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/v1/webhook_endpoints/{id}",
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([
'url' => '<string>',
'enabled_events' => [
'<string>'
],
'description' => '<string>',
'filters' => [
'carriers' => [
'<string>'
],
'connections' => [
'<string>'
],
'user_metadata' => [
]
],
'user_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/v1/webhook_endpoints/{id}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"enabled_events\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"filters\": {\n \"carriers\": [\n \"<string>\"\n ],\n \"connections\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\n },\n \"user_metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/v1/webhook_endpoints/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"enabled_events\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"filters\": {\n \"carriers\": [\n \"<string>\"\n ],\n \"connections\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\n },\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/webhook_endpoints/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"enabled_events\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"filters\": {\n \"carriers\": [\n \"<string>\"\n ],\n \"connections\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\n },\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "we_1Q2w3E4r",
"object": "webhook_endpoint",
"livemode": true,
"created": 123,
"url": "<string>",
"enabled_events": [
"<string>"
],
"status": "enabled",
"updated": 123,
"description": "<string>",
"api_version": "<string>",
"filters": {
"carriers": [
"<string>"
],
"connections": [
"<string>"
],
"user_metadata": {}
},
"secret": "<string>",
"secret_preview": "<string>",
"disabled_reason": "<string>",
"delivery": {
"last_success_at": 123,
"last_failure_at": 123,
"failure_streak": 123
},
"user_metadata": {},
"carrier_metadata": {},
"system_metadata": {
"source": "api",
"created_by": {
"type": "api_key",
"id": "<string>"
},
"request_id": "<string>",
"idempotency_key": "<string>",
"batch": "<string>",
"generated": true,
"test_scenario": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}Authorizations
apiKeyoauth2
sk_test_ / sk_live_ / rk_test_ / rk_live_ keys
Headers
Act on behalf of a connected account (acct_...)
Path Parameters
Body
application/json
Response
OK
Prefixed we_
Example:
"we_1Q2w3E4r"
Available options:
webhook_endpoint Unix timestamp (seconds)
Available options:
enabled, disabled, auto_disabled Unix timestamp (seconds)
Show child attributes
Show child attributes
Only returned on create and rotate_secret
Show child attributes
Show child attributes
Client-writable. Up to 50 string key/value pairs. Never sent to carriers.
Show child attributes
Show child attributes
Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.
Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.
Show child attributes
Show child attributes