Update a webhook

A partial update. Pause or resume an endpoint, change where it points, or change which events it receives — all without rotating the signing secret. PATCH /v1/webhooks/{id}

Path parameters

string

required

The webhook endpoint id to update.

Body

Send any subset of the following. Omitted fields are left unchanged.

string

New HTTPS endpoint to deliver events to.

boolean

false pauses deliveries; true resumes them.

string[]

Replace the subscribed event list. See the full set on create.

The secret survives. Updating an endpoint keeps its signingSecret. To rotate the secret, delete the endpoint and create a new one.

Request

curl -X PATCH https://api.drin.run/v1/webhooks/wh_3kQ9p2 \
  -H "Authorization: Bearer $DRIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": false }'

import { DrinClient } from "@drin00/sdk";

const drin = new DrinClient({ apiKey: process.env.DRIN_API_KEY });

// Pause deliveries — secret is preserved.
await drin.webhooks.update("wh_3kQ9p2", { enabled: false });

// Repoint and re-subscribe in one call.
await drin.webhooks.update("wh_3kQ9p2", {
  url: "https://example.com/hooks/v2",
  eventTypes: ["delivery", "bounce", "complaint", "open", "click"],
});

Response

Returns 200 OK with the updated endpoint (secret redacted). An unknown id returns 404 not_found.

200 OK

{
  "id": "wh_3kQ9p2",
  "url": "https://example.com/hooks/drin",
  "enabled": false,
  "eventTypes": ["delivery", "bounce", "complaint"],
  "signingSecret": ""
}

Overview

Emails

Domains

Inboxes

Threads

Inbound

Webhooks

Suppressions

Contacts

Templates

Metrics

API keys

Update a webhook

Path parameters

Body

Request

Response

​Path parameters

​Body

​Request

​Response

Path parameters

Body

Request

Response