Retrieve a webhook

Fetch a single endpoint by id, including its current URL, enabled state, and subscribed event types. GET /v1/webhooks/{id}

Path parameters

string

required

The webhook endpoint id, e.g. wh_3kQ9p2.

Request

curl https://api.drin.run/v1/webhooks/wh_3kQ9p2 \
  -H "Authorization: Bearer $DRIN_API_KEY"

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

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

const hook = await drin.webhooks.get("wh_3kQ9p2");

Response

Returns 200 OK with the endpoint. signingSecret is redacted to an empty string. An id that is unknown or not visible to this project returns 404 not_found.

200 OK

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

Overview

Emails

Domains

Inboxes

Threads

Inbound

Webhooks

Suppressions

Contacts

Templates

Metrics

API keys

Retrieve a webhook

Path parameters

Request

Response

​Path parameters

​Request

​Response

Path parameters

Request

Response