Test one buyer-agent webhook endpoint
curl --request POST \
--url https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/notification-subscriptions/{subscriberId}/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"storefrontId": 4503599627370495,
"confirmationText": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/notification-subscriptions/{subscriberId}/test"
payload = {
"storefrontId": 4503599627370495,
"confirmationText": "<string>"
}
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({storefrontId: 4503599627370495, confirmationText: '<string>'})
};
fetch('https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/notification-subscriptions/{subscriberId}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"principalId": "<string>",
"subscriberId": "<string>",
"storefrontId": 4503599627370495,
"configurationVersion": "<string>",
"challenged": 0,
"verified": 0,
"failed": 0
},
"error": null
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Buyer Agent Principals
Test one buyer-agent webhook endpoint
Re-check an existing active caller-level subscription with the non-business AdCP subscriber challenge. A directly authenticated WorkOS organization administrator must confirm the buyer-agent display name. The server validates and pins the destination to prevent SSRF, performs no network I/O while an authorization transaction is open, and returns only proof outcome counts; it does not send a domain event or expose credentials.
POST
/
buyer-agent-principals
/
{principalId}
/
notification-subscriptions
/
{subscriberId}
/
test
Test one buyer-agent webhook endpoint
curl --request POST \
--url https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/notification-subscriptions/{subscriberId}/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"storefrontId": 4503599627370495,
"confirmationText": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/notification-subscriptions/{subscriberId}/test"
payload = {
"storefrontId": 4503599627370495,
"confirmationText": "<string>"
}
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({storefrontId: 4503599627370495, confirmationText: '<string>'})
};
fetch('https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/notification-subscriptions/{subscriberId}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"principalId": "<string>",
"subscriberId": "<string>",
"storefrontId": 4503599627370495,
"configurationVersion": "<string>",
"challenged": 0,
"verified": 0,
"failed": 0
},
"error": null
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Path Parameters
Pattern:
^prin_[A-Za-z0-9_-]{32}$Pattern:
^[A-Za-z0-9_.:-]{1,64}$Body
application/json