Skip to main content
POST

Scope

What it does

Creates a webhook for the chosen events. The signing secret is returned only in this response.

Use cases

  • Receive approved sales in your system
  • Automate product delivery
string
required
Public https:// address that receives the events.
string[]
required
One or more of: purchase_approved, pix_generated, purchase_refunded, subscription_created, subscription_renewed, subscription_canceled, withdrawal_paid, withdrawal_failed, affiliate_approved.
string
Name for you to recognize (up to 80 characters). Default: API.

Response

object
string
Signing secret (whsec_…). Only appears here.

Errors