For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusDashboard
  • Getting Started
    • Introduction
    • Authentication
    • Rate Limits
    • Error Handling
  • Guides
    • Cash-In (Receiving Payments)
    • Cash-Out (Sending Payments)
    • PIX Keys Management
    • Webhooks Integration
    • MED (Special Returns)
  • API Reference
      • GETList Webhooks
      • POSTCreate Webhook
      • GETGet Webhook by ID
      • PUTUpdate Webhook
      • DELDelete Webhook
      • GETList Deliveries
      • GETGet Delivery by ID
      • POSTResend Delivery
LogoLogo
StatusDashboard
API ReferenceWebhooks

Create Webhook

POST
https://api.brzip.com.br/api/v1/webhooks
POST
/api/v1/webhooks
$curl -X POST https://api.brzip.com.br/api/v1/webhooks \
>     -H "Content-Type: application/json" \
>     -d '{
>  "url": "https://api.example.com/webhooks/pix"
>}'
201Created
1{}

Creates a new webhook to receive PIX event notifications.

IMPORTANT: The secret is returned only at creation time. Store it securely for signature validation.

Was this page helpful?
Previous

Get Webhook by ID

Next
Built with

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"
HTTPS URL that will receive notifications
eventslist of stringsOptional

List of events to subscribe to. If empty or ["*"], receives all events.

Response

Webhook created successfully