Pause a webhook endpoint
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:pause \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:pause', 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}:pause"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:pause")
.header("Authorization", "Bearer <token>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:pause"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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}:pause",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 11069,
"resource": "webhook-endpoint",
"partnerId": 1069,
"url": "https://hooks.example-transit.example.com/allride-voucher",
"description": "Redemption and catalog notifications",
"eventTypes": [
"redemption-created",
"redemption-voided",
"catalog-voucher-set-available",
"catalog-voucher-set-unavailable"
],
"status": "paused",
"firstSecretRotatedAt": "2026-10-22T10:05:00Z",
"secondSecretRotatedAt": "2026-10-22T10:05:00Z",
"deliveriesBlockedReason": null,
"createdAt": "2026-10-22T10:05:00Z",
"updatedAt": "2026-10-22T10:05:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/webhook-endpoints/11069",
"type": "application/json"
},
"deliveries": {
"href": "https://api.voucher.allride.io/partner/v1/webhook-deliveries?filter%5BwebhookEndpointId%5D=11069",
"type": "application/json"
}
}
}
}Webhook endpoints
Pause a webhook endpoint
Pauses deliveries (active → paused). Events while paused are logged as FAILED deliveries and can be replayed within 30 days of the event (resume the endpoint first). 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}
:pause
Pause a webhook endpoint
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:pause \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:pause', 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}:pause"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:pause")
.header("Authorization", "Bearer <token>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/webhook-endpoints/{webhookEndpointId}:pause"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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}:pause",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 11069,
"resource": "webhook-endpoint",
"partnerId": 1069,
"url": "https://hooks.example-transit.example.com/allride-voucher",
"description": "Redemption and catalog notifications",
"eventTypes": [
"redemption-created",
"redemption-voided",
"catalog-voucher-set-available",
"catalog-voucher-set-unavailable"
],
"status": "paused",
"firstSecretRotatedAt": "2026-10-22T10:05:00Z",
"secondSecretRotatedAt": "2026-10-22T10:05:00Z",
"deliveriesBlockedReason": null,
"createdAt": "2026-10-22T10:05:00Z",
"updatedAt": "2026-10-22T10:05:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/webhook-endpoints/11069",
"type": "application/json"
},
"deliveries": {
"href": "https://api.voucher.allride.io/partner/v1/webhook-deliveries?filter%5BwebhookEndpointId%5D=11069",
"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 <= 18446744073709552000Response
OK
Single-object envelope around a WebhookEndpoint.
A webhook endpoint (secrets are never returned after they are issued).
Show child attributes
Show child attributes