List webhook endpoints

GET/v1/webhook-endpointsList webhook endpoints

Parameters

cursorstringquery

minLength 1

limitintegerquery

default 25 · maximum 100 · minimum 1

Responses

objectWebhookEndpointPage

dataarray of objectrequired

Show child attributes

Show array items

created_atstring · date-timerequired

enabledbooleanrequired

eventsarray of stringrequired

Show child attributes

idstringrequired

objectvaluerequired

const "webhook_endpoint"

signing_secret_hintstring

urlstring · urirequired

has_morebooleanrequired

next_cursornull | stringrequired

Example response

{
  "data": [
    {
      "created_at": "2026-06-09T00:00:00Z",
      "enabled": true,
      "events": [
        "pickup.completed"
      ],
      "id": "whe_00000000000000000001",
      "object": "webhook_endpoint",
      "signing_secret_hint": "synthetic-key-ending-0000",
      "url": "https://hooks.parcel-events.example/events"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Examples

cursorquery parameter

limitquery parameter

curl -X GET 'https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25'

const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.parcel-events.example/v1/webhook-endpoints?cursor=string&limit=25");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "created_at": "2026-06-09T00:00:00Z",
      "enabled": true,
      "events": [
        "pickup.completed"
      ],
      "id": "whe_00000000000000000001",
      "object": "webhook_endpoint",
      "signing_secret_hint": "synthetic-key-ending-0000",
      "url": "https://hooks.parcel-events.example/events"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Search documentation

Parameters

Responses

Documentation menu