Update a webhook | Paid | Documentation

Enable or disable a webhook and configure the destination URL for the authenticated organization.

AuthorizationBearer

API Key authentication using Bearer token

webhookNameenumRequired

Body

enabledbooleanOptional

Whether the webhook is enabled for delivery.

urlstring or nullOptionalformat: "uri"

The HTTPS endpoint Paid should deliver this webhook to. Set to null to clear it while disabled.

200

idstring

nameenum

descriptionstring

enabledboolean

urlstring or null

lastSentAtdatetime or null

lastStatusenum

Allowed values:

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	import { PaidClient } from "@paid-ai/paid-node";
2
3	async function main() {
4	const client = new PaidClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.webhooks.updateWebhook("billing-invoice-created", {});
8	}
9	main();

1	{
2	"id": "wh_9f8b7c6d-1234-4a56-8e9f-0a1b2c3d4e5f",
3	"name": "billing-invoice-created",
4	"description": "Triggered when a new billing invoice is created for the organization.",
5	"enabled": true,
6	"url": "https://webhooks.mycompany.com/billing/invoice-created",
7	"lastSentAt": "2024-01-15T09:30:00Z",
8	"lastStatus": "success"
9	}