Send a test ping
curl --request POST \
--url https://my.server.express/api/v1/user/webhooks/{id}/test \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.server.express/api/v1/user/webhooks/{id}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.server.express/api/v1/user/webhooks/{id}/test"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "<string>",
"status": "pending",
"attempts": 1,
"responseCode": 123,
"error": "<string>"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Webhooks
Send a test ping
Sends a ping event to the endpoint synchronously and returns how it went (capped by the 10-second request timeout). A
failed ping retries on the normal schedule. Switched-off endpoint → 409. Rate limited to 6 requests per minute.
POST
/
v1
/
user
/
webhooks
/
{id}
/
test
Send a test ping
curl --request POST \
--url https://my.server.express/api/v1/user/webhooks/{id}/test \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.server.express/api/v1/user/webhooks/{id}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.server.express/api/v1/user/webhooks/{id}/test"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "<string>",
"status": "pending",
"attempts": 1,
"responseCode": 123,
"error": "<string>"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}