Get Webhook

Gets one webhook by ID. The signing secret is never returned here — only webhooks.create and webhooks.sync show one, when they create the webhook.

POST /v1/webhooks.get

Typescript (SDK)

TypeScript

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.webhooks.get({
  id: "billing",
});

200

{
  "id": "billing",
  "url": "https://example.com/webhooks/autumn",
  "events": [
    "billing.updated",
    "invoice.finalized"
  ],
  "description": "Plan changes and invoices",
  "disabled": false,
  "created_at": 1781113864000,
  "updated_at": 1781113864000
}

Body Parameters

Response

200

{
  "id": "billing",
  "url": "https://example.com/webhooks/autumn",
  "events": [
    "billing.updated",
    "invoice.finalized"
  ],
  "description": "Plan changes and invoices",
  "disabled": false,
  "created_at": 1781113864000,
  "updated_at": 1781113864000
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version · string · default: 2.4.0 · required

Body

application/json

id · string · required

The webhook's ID. Webhooks made in the dashboard use the ep_… ID shown by webhooks.list.

Required string length: 1 - 256

Pattern: ^[a-zA-Z0-9_-]+$

Response

200 - application/json

OK

id · string · required

The webhook's ID. Webhooks made in the dashboard show their ep_… ID.

url · string · required

The URL Autumn sends events to.

description · string | null · required

A note for your own reference.

events · string[] · required

The events sent to this webhook, as WebhookEventType names; a type newer than your client is returned as-is. Empty means the webhook receives every event.

disabled · boolean · required

When true, no events are sent to the webhook.

created_at · number · required

When the webhook was created, ms since epoch.

updated_at · number · required

When the webhook was last changed, ms since epoch.