curl --request POST \
--url https://my.flowsign.app/api/v1/webhooks/{endpointId}/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"event": "PACKAGE_COMPLETED"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({event: 'PACKAGE_COMPLETED'})
};
fetch('https://my.flowsign.app/api/v1/webhooks/{endpointId}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({event: 'PACKAGE_COMPLETED'})
};
fetch('https://my.flowsign.app/api/v1/webhooks/{endpointId}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://my.flowsign.app/api/v1/webhooks/{endpointId}/test';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({event: 'PACKAGE_COMPLETED'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/webhooks/{endpointId}/test"
payload = { "event": "PACKAGE_COMPLETED" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/webhooks/{endpointId}/test");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"event\": \"PACKAGE_COMPLETED\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/webhooks/{endpointId}/test");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"event\": \"PACKAGE_COMPLETED\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://my.flowsign.app/api/v1/webhooks/{endpointId}/test' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"event": "PACKAGE_COMPLETED"
}'{
"data": {
"deliveryId": "cmg1hb9r40008v8p9k2n7ya5c",
"status": "DELIVERED",
"responseStatus": 200,
"error": "HTTP 503"
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}Send a test event
Sends a signed sample of the chosen event to the endpoint straight away, even while it is paused or failing, and returns the outcome. The payload carries "test": true and sample data in the event’s usual shape. A test delivery is tried once, is listed with the endpoint’s deliveries, and never counts towards the endpoint failing. Requires canManageWebhooks.
curl --request POST \
--url https://my.flowsign.app/api/v1/webhooks/{endpointId}/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"event": "PACKAGE_COMPLETED"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({event: 'PACKAGE_COMPLETED'})
};
fetch('https://my.flowsign.app/api/v1/webhooks/{endpointId}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({event: 'PACKAGE_COMPLETED'})
};
fetch('https://my.flowsign.app/api/v1/webhooks/{endpointId}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://my.flowsign.app/api/v1/webhooks/{endpointId}/test';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({event: 'PACKAGE_COMPLETED'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/webhooks/{endpointId}/test"
payload = { "event": "PACKAGE_COMPLETED" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/webhooks/{endpointId}/test");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"event\": \"PACKAGE_COMPLETED\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/webhooks/{endpointId}/test");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"event\": \"PACKAGE_COMPLETED\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://my.flowsign.app/api/v1/webhooks/{endpointId}/test' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"event": "PACKAGE_COMPLETED"
}'{
"data": {
"deliveryId": "cmg1hb9r40008v8p9k2n7ya5c",
"status": "DELIVERED",
"responseStatus": 200,
"error": "HTTP 503"
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}{
"error": "Missing permission: canSendPackages",
"details": {
"recipients.0.email": [
"Invalid email"
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The workspace the key was issued for, as returned by GET /api/v1/workspaces. Optional: omitting it acts in the key's workspace, and any other id is rejected with 401.
Path Parameters
Body
The event to send a sample of. The endpoint must be subscribed to it.
PACKAGE_SENT, PACKAGE_COMPLETED, PACKAGE_VOIDED, PACKAGE_EXPIRED, PACKAGE_DECLINED, PACKAGE_ON_HOLD, PACKAGE_RESUMED, PACKAGE_SCHEDULED, PACKAGE_DELETED, SESSION_SENT, SESSION_OPENED, SESSION_COMPLETED, SESSION_DECLINED, SESSION_REMINDED, SESSION_CANCELLED "PACKAGE_COMPLETED"
Response
Success
Show child attributes
Show child attributes
Was this page helpful?

