webhooks

Update a webhook

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

patch/webhooks/{webhookName}

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/webhooks/{webhookName}
  • Auth: HTTP bearer

Path parameters

webhookName'billing-invoice-created' | 'billing-invoice-paid' | 'billing-invoice-posted' | 'billing-checkout-created' | 'billing-checkout-completed' | 'billing-checkout-expired' | 'billing-payment-succeeded' | 'billing-payment-failed' | 'billing-credits-depleted' | 'billing-overage-incurred' | 'billing-credit-cap-reached' required

Request body

enabledboolean

Whether the webhook is enabled for delivery.

urlstring uri nullable

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

Response

200

idstring required
name'billing-invoice-created' | 'billing-invoice-paid' | 'billing-invoice-posted' | 'billing-checkout-created' | 'billing-checkout-completed' | 'billing-checkout-expired' | 'billing-payment-succeeded' | 'billing-payment-failed' | 'billing-credits-depleted' | 'billing-overage-incurred' | 'billing-credit-cap-reached' required
descriptionstring required
enabledboolean required
urlstring nullable required
lastSentAtstring date-time nullable required
lastStatus'success' | 'failed' required
signingSecretstring

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.

Changes

No recorded changes to this operation across all 1 revision of this API.