Update a webhook endpoint

PATCH/v1/webhook-endpoints/{endpoint_id}Update a webhook endpoint

Parameters

endpoint_idstringpathrequired

pattern ^whe_[a-z0-9]{20}$

Request body

required

application/merge-patch+json

objectUpdateWebhookEndpointRequest

minProperties 1

enabledboolean

eventsarray of string

minItems 1 · uniqueItems true

Show child attributes

minItems 1 · uniqueItems true

urlstring · uri

Example request

{
  "enabled": true,
  "events": [
    "pickup.completed"
  ],
  "url": "https://example.com"
}

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

{
  "request_id": "req_00000000000000000004",
  "status": 404,
  "title": "Synthetic resource was not found",
  "type": "https://parcel-events.example/problems/not-found"
}

Examples

endpoint_idrequiredpath parameter

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

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

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

import requests

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

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"enabled":true,"events":["pickup.completed"],"url":"https://example.com"}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://api.parcel-events.example/v1/webhook-endpoints/string", 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/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"enabled\":true,\"events\":[\"pickup.completed\"],\"url\":\"https://example.com\"}");
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/string"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"enabled\":true,\"events\":[\"pickup.completed\"],\"url\":\"https://example.com\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.parcel-events.example/v1/webhook-endpoints/string")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"enabled\":true,\"events\":[\"pickup.completed\"],\"url\":\"https://example.com\"}"
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.Patch, "https://api.parcel-events.example/v1/webhook-endpoints/string");
request.Content = new StringContent("{\"enabled\":true,\"events\":[\"pickup.completed\"],\"url\":\"https://example.com\"}", 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"
}

{
  "request_id": "req_00000000000000000004",
  "status": 404,
  "title": "Synthetic resource was not found",
  "type": "https://parcel-events.example/problems/not-found"
}

Search documentation

Parameters

Request body

Responses

Documentation menu