import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.webhooks.update({
id: "billing",
disabled: true,
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.webhooks.update(id="billing", disabled=True)curl --request POST \
--url https://api.useautumn.com/v1/webhooks.update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"id": "billing",
"disabled": true
}
'{
"id": "billing",
"url": "https://example.com/webhooks/autumn",
"events": [
"billing.updated",
"invoice.finalized"
],
"description": "Plan changes and invoices",
"disabled": true,
"created_at": 1781113864000,
"updated_at": 1781113864000
}
Update Webhook
Updates a webhook’s URL, events, description or disabled state. Only the fields you pass change. The ID can’t be changed — to rename, create a new webhook.
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.webhooks.update({
id: "billing",
disabled: true,
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.webhooks.update(id="billing", disabled=True)curl --request POST \
--url https://api.useautumn.com/v1/webhooks.update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"id": "billing",
"disabled": true
}
'{
"id": "billing",
"url": "https://example.com/webhooks/autumn",
"events": [
"billing.updated",
"invoice.finalized"
],
"description": "Plan changes and invoices",
"disabled": true,
"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": true,
"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_-]+$The https URL Autumn sends events to. Localhost and private-network addresses are rejected; tunnels such as ngrok work.
^[Hh][Tt][Tt][Pp][Ss]:\/\/The events sent to this webhook. At least one. vercel.* events can't be mixed with other events.
1An event type the webhook receives.
customer.products.updated, customer.threshold_reached, balances.usage_alert_triggered, balances.limit_reached, billing.auto_topup_failed, billing.auto_topup_succeeded, billing.updated, invoice.finalized, vercel.resources.deleted, vercel.resources.provisioned, vercel.resources.rotate_secrets, vercel.webhooks.event A note for your own reference.
When true, no events are sent to the webhook.
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.