import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.webhooks.get({
id: "billing",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.webhooks.get(id="billing")curl --request POST \
--url https://api.useautumn.com/v1/webhooks.get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"id": "billing"
}
'{
"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
}
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.
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.webhooks.get({
id: "billing",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.webhooks.get(id="billing")curl --request POST \
--url https://api.useautumn.com/v1/webhooks.get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"id": "billing"
}
'{
"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
{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
The webhook's ID. Webhooks made in the dashboard use the ep_… ID shown by webhooks.list.
1 - 256^[a-zA-Z0-9_-]+$Response
OK
The webhook's ID. Webhooks made in the dashboard show their ep_… ID.
The URL Autumn sends events to.
A note for your own reference.
The events sent to this webhook, as WebhookEventType names; a type newer than your client is returned as-is. Empty only for a webhook made in the dashboard that receives every event.
When true, no events are sent to the webhook.
When the webhook was created, ms since epoch.
When the webhook was last changed, ms since epoch.