Send a test event
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "Hello from Example Transit"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({message: 'Hello from Example Transit'})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event"
payload = { "message": "Hello from Example Transit" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"Hello from Example Transit\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event"
payload := strings.NewReader("{\n \"message\": \"Hello from Example Transit\"\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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event",
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([
'message' => 'Hello from Example Transit'
]),
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;
}{
"data": {
"resource": "webhook-trigger",
"webhookDeliveryId": 21069,
"webhookEventId": "3f1c9a52-7b4e-4d21-9c6a-0e5d8b2f4a17",
"status": "PENDING",
"_links": {
"delivery": {
"href": "https://api.voucher.allride.io/partner/v1/webhook-deliveries/21069",
"type": "application/json"
}
}
}
}Webhook endpoints
Send a test event
Stores one webhook-endpoint-test event for an active endpoint, even if it is not subscribed to that type, and queues its send. The delivery appears in the log at once as PENDING; follow it by webhookDeliveryId. Normal retries apply. Endpoints that include billing event types also need view-consumer-billing, and price-terms-* types view-consumer-pricing (403 missing-permission otherwise).
Required permissions: manage-webhooks · API keys: allowed
POST
/
partner
/
v1
/
webhook-endpoints
/
{webhookEndpointId}
:send-test-event
Send a test event
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "Hello from Example Transit"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({message: 'Hello from Example Transit'})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event"
payload = { "message": "Hello from Example Transit" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"Hello from Example Transit\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event"
payload := strings.NewReader("{\n \"message\": \"Hello from Example Transit\"\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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:send-test-event",
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([
'message' => 'Hello from Example Transit'
]),
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;
}{
"data": {
"resource": "webhook-trigger",
"webhookDeliveryId": 21069,
"webhookEventId": "3f1c9a52-7b4e-4d21-9c6a-0e5d8b2f4a17",
"status": "PENDING",
"_links": {
"delivery": {
"href": "https://api.voucher.allride.io/partner/v1/webhook-deliveries/21069",
"type": "application/json"
}
}
}
}Authorizations
Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.
Headers
Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.
Required string length:
1 - 255Pattern:
^[\x21-\x7E]{1,255}$Path Parameters
Webhook endpoint id. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.
Required range:
0 <= x <= 18446744073709552000Body
application/json
Test event.
Message in the test payload (at most 200 characters; default "Test event from AllRide Voucher Platform").
Maximum string length:
200Response
Accepted
Single-object envelope around a WebhookTrigger.
A queued test event or replay: the stored event is PENDING until it is delivered or its last attempt fails.
Show child attributes
Show child attributes