Skip to Content
Prets Developer Portal

Update an event destination

PATCH
/v1/events/destinations/{destinationId}

to try read requests with your account, or paste an API key into the Authorization field. Create an API key in the Partner Portal.

Changes an event destination's name, url, or both. A new url applies to subsequent deliveries; the bearer secret stays the same.

Returns the updated destination. Returns 404 when the destination does not exist or belongs to another organization.

Path Parameters

destinationId*string

Event destination id

Match^whk_[0-9A-HJKMNP-TV-Z]{26}$

Request Body

application/json
  1. body

Partial update of an event destination. At least one of name or url is required.

name*string

Human-readable label for this destination within the organization.

Length1 <= length <= 128
url*string

Public HTTPS endpoint that will receive event deliveries. Plain HTTP is rejected.

Match^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@&=+$,A-Za-z0-9])+)([).!';/?:,])?$
Lengthlength <= 2048

Response Body

The updated event destination

application/json
  1. response

HTTPS endpoint registered for outbound event delivery. Scoped to the authenticated organization.

destinationId*string

Stable destination id. Client-supplied at create, or server-generated when omitted.

Match^whk_[0-9A-HJKMNP-TV-Z]{26}$
name*string

Human-readable label for this destination within the organization.

Length1 <= length <= 128
url*string

Public HTTPS endpoint that will receive event deliveries. Plain HTTP is rejected.

Match^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@&=+$,A-Za-z0-9])+)([).!';/?:,])?$
Lengthlength <= 2048
createdAt*string

When the destination was registered

Formatdate-time
updatedAt*string

When the destination name or URL last changed

Formatdate-time

Authorization

bearerAuth
headerAuthorizationBearer <token>
Example Request
curl -X PATCH 'https://api.prets.app/v1/events/destinations/whk_01ARZ3NDEKTSV4RRFFQ69G5FAV' \  -H 'Content-Type: application/json' \  -d '{  "name": "Production",  "url": "https://example.com/prets/events"}'
Example Response
{  "destinationId": "whk_01ARZ3NDEKTSV4RRFFQ69G5FAV",  "name": "Production",  "url": "https://example.com/prets/events",  "createdAt": "2026-06-01T12:00:00.000Z",  "updatedAt": "2026-06-01T12:00:00.000Z"}