Get a webhook endpoint

Scope webhooks.manage

Path parameters

idstringrequired

Returns

12 fields of the 200 answer

idstringrequired

urlstringrequired

descriptionstring or nullrequired

eventsarray of stringrequired

filtersobjectrequired

4 fields

postflowIdstring

postbatchIdstring

isTestboolean

integrationInstallationIdstring

activebooleanrequired

failureStreakintegerrequired

disabledAtdate-time or nullrequired

lastDeliveryAtdate-time or nullrequired

lastStatusenum or nullrequired

SUCCEEDEDFAILEDEXHAUSTED

createdAtdate-timerequired

updatedAtdate-timerequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

Request

curl https://api.postbuddy.nl/v1/webhooks/wh_01J9Y2K8QF4T6W8Z0B2D4F6H8K \
  -H "Authorization: Bearer $POSTBUDDY_API_KEY"

import { PostBuddyClient } from '@postbuddy/sdk';

const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! });

const result = await client.webhooks.get('wh_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

import os
from postbuddy import Client

client = Client(os.environ["POSTBUDDY_API_KEY"])

result = client.webhooks.get("wh_01J9Y2K8QF4T6W8Z0B2D4F6H8K")

Response

{
  "id": "wh_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
  "url": "https://example.com/r/Fq3ZtR8w",
  "description": "Welcome card for new customers",
  "events": [
    "Example"
  ],
  "filters": {
    "postflowId": "pf_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
    "postbatchId": "pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
    "isTest": false,
    "integrationInstallationId": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K"
  },
  "active": true,
  "failureStreak": 1,
  "disabledAt": "2026-10-16T09:14:02.000Z",
  "lastDeliveryAt": "2026-10-16T09:14:02.000Z",
  "lastStatus": "SUCCEEDED",
  "createdAt": "2026-10-16T09:14:02.000Z",
  "updatedAt": "2026-10-16T09:14:02.000Z"
}

{
  "type": "https://docs.postbuddy.nl/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Not found",
  "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K"
}