Register a webhook endpoint

POST/v1/webhook-endpointsRegister a webhook endpoint

Request body

required

application/json

objectCreateWebhookEndpointRequest

descriptionnull | string

maxLength 120

eventsarray of stringrequired

minItems 1 · uniqueItems true

Show child attributes

minItems 1 · uniqueItems true

urlstring · urirequired

Example request

{
  "description": "string",
  "events": [
    "pickup.completed"
  ],
  "url": "https://hooks.parcel-events.example/events"
}

Responses

objectWebhookEndpoint

created_atstring · date-timerequired

enabledbooleanrequired

eventsarray of stringrequired

Show child attributes

idstringrequired

objectvaluerequired

const "webhook_endpoint"

signing_secret_hintstring

urlstring · urirequired

Example response

{
  "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"
}

objectProblem

detailstring

errorsarray of object

Show child attributes

Show array items

messagestringrequired

pathstringrequired

request_idstringrequired

statusintegerrequired

maximum 599 · minimum 400

titlestringrequired

typestring · urirequired

Example response

{
  "errors": [
    {
      "message": "must be a synthetic postal code",
      "path": "recipient.postal_code"
    }
  ],
  "request_id": "req_00000000000000000006",
  "status": 422,
  "title": "Synthetic request validation failed",
  "type": "https://parcel-events.example/problems/validation"
}

Examples

curl -X POST 'https://api.parcel-events.example/v1/webhook-endpoints' \
  -H 'Content-Type: application/json' \
  -d '{"description":"string","events":["pickup.completed"],"url":"https://hooks.parcel-events.example/events"}'

const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"description":"string","events":["pickup.completed"],"url":"https://hooks.parcel-events.example/events"}),
});
const data = await response.json();

const response = await fetch('https://api.parcel-events.example/v1/webhook-endpoints', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"description\":\"string\",\"events\":[\"pickup.completed\"],\"url\":\"https://hooks.parcel-events.example/events\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.parcel-events.example/v1/webhook-endpoints",
    headers={"Content-Type": "application/json"},
    data='{"description":"string","events":["pickup.completed"],"url":"https://hooks.parcel-events.example/events"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"description":"string","events":["pickup.completed"],"url":"https://hooks.parcel-events.example/events"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.parcel-events.example/v1/webhook-endpoints", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	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");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"description\":\"string\",\"events\":[\"pickup.completed\"],\"url\":\"https://hooks.parcel-events.example/events\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.parcel-events.example/v1/webhook-endpoints"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"description\":\"string\",\"events\":[\"pickup.completed\"],\"url\":\"https://hooks.parcel-events.example/events\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.parcel-events.example/v1/webhook-endpoints")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"description\":\"string\",\"events\":[\"pickup.completed\"],\"url\":\"https://hooks.parcel-events.example/events\"}"
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.Post, "https://api.parcel-events.example/v1/webhook-endpoints");
request.Content = new StringContent("{\"description\":\"string\",\"events\":[\"pickup.completed\"],\"url\":\"https://hooks.parcel-events.example/events\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "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"
}

{
  "errors": [
    {
      "message": "must be a synthetic postal code",
      "path": "recipient.postal_code"
    }
  ],
  "request_id": "req_00000000000000000006",
  "status": 422,
  "title": "Synthetic request validation failed",
  "type": "https://parcel-events.example/problems/validation"
}

Search documentation

Request body

Responses

Documentation menu