Update a webhook | Paid | Documentation

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

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

webhookNameenumRequired

Request

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.

Response

200

idstring

nameenum

descriptionstring

enabledboolean

urlstring or null

lastSentAtdatetime or null

lastStatusenum

signingSecretstringOptional

Included on the response of the first save that produced a signing key for this organization (when no webhook had a key yet). Store it now — subsequent reads will not return it; rotate to mint a new one if you lose it.

Errors

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": "string",
3	"name": "billing-invoice-created",
4	"description": "string",
5	"enabled": true,
6	"url": "string",
7	"lastSentAt": "2024-01-15T09:30:00Z",
8	"lastStatus": "success",
9	"signingSecret": "string"
10	}