Test a webhook
curl --request POST \
--url https://api.pomerado.ai/v1/webhooks/{id}/test \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.pomerado.ai/v1/webhooks/{id}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pomerado.ai/v1/webhooks/{id}/test"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"delivered": true,
"status": 123,
"failure": "invalid_url"
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}Webhooks
Test a webhook
Send a signed test event to one of your webhooks and report how its receiver responded.
POST
/
v1
/
webhooks
/
{id}
/
test
Test a webhook
curl --request POST \
--url https://api.pomerado.ai/v1/webhooks/{id}/test \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.pomerado.ai/v1/webhooks/{id}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pomerado.ai/v1/webhooks/{id}/test"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"delivered": true,
"status": 123,
"failure": "invalid_url"
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"docs_url": "<string>",
"details": {}
}
}Details
Details
- It is sent now, whether the webhook is active or not.
- The event is {“id”, “type”: “webhook.test”, “created_at”, “data”: {“webhook_id”}}.
- It is not retried and does not count toward turning the webhook off.
- Callers: an API key, an MCP OAuth token or a Dashboard session.
-
Permission:
jobs:read. - Effect: Creates or changes something.
-
Errors:
not_found,webhook_secret_unreadable,webhooks_unavailable, and the errors any request can get.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
a webhook ID: wh_ and 32 lowercase hex digits
Example:
"wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"
Response
How the receiver answered
The receiver answered with a 2xx
The receiver's HTTP status, or null when none answered
Why no receiver answered: forbidden_address when the URL resolves to a private address, timeout after 10 seconds, or unreachable
Available options:
invalid_url, forbidden_address, timeout, unreachable