Update

Updates a webhook event and/or url listener. Once updated all events that are triggered will replicate the updated logic

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

webhook primary identifier

Body Params

All fields are optional. Send only the ones you want to change.
event: One of the supported event types.
url: An https url that will receive the POST of the event.
headers: optional key-value pairs to send with the POST of the event. Send null to clear them.
enabled: re-enable a webhook that was previously disabled (after repeated delivery failures or via internal cleanup).

Partial update of a webhook. All fields are optional.

string

New https url that will receive the POST of the event

string
enum

Event the webhook subscribes to. Use all to receive every event for the client. Events are grouped by topic:

item/ – Lifecycle of an item (a connection to a financial institution).

  • item/created: a new item was created.
  • item/updated: the item finished an execution with new data.
  • item/error: the execution finished with an error (see the payload's error field).
  • item/deleted: the item was deleted.
  • item/waiting_user_input: the item needs additional credentials/MFA from the end user.
  • item/waiting_user_action: the item needs the end user to perform an action on the institution side.
  • item/login_succeeded: the credentials were accepted by the institution (data may still be syncing).

connector/ – Connector-level events.

  • connector/status_updated: a connector's health status changed (ONLINE/OFFLINE/UNSTABLE).

transactions/ – Account transaction lifecycle.

  • transactions/created / transactions/updated / transactions/deleted: a transaction was inserted, modified or removed during an item execution.

payment_intent/ – Payment Initiation flow (single PIX).

  • payment_intent/created: a payment intent was created.
  • payment_intent/completed: the payment was confirmed by the institution.
  • payment_intent/waiting_payer_authorization: the payer still needs to authorize the payment.
  • payment_intent/error: the payment was rejected or failed.

payment_request/ – Aggregate payment request state.

  • payment_request/updated: the overall status of a payment request changed.

scheduled_payment/ – Scheduled (recurring or future) payments.

  • scheduled_payment/created / completed / error / canceled: lifecycle of a single scheduled payment.
  • scheduled_payment/all_created / scheduled_payment/all_completed: emitted once when every scheduled payment in a series reaches the same terminal state.

boleto/ – Boleto status updates.

  • boleto/updated: the boleto data was updated (e.g. paid, expired, amount changed).

automatic_pix_payment/ – Recurring PIX (PIX Automático) individual payments.

  • automatic_pix_payment/created: a new recurring payment was scheduled.
  • automatic_pix_payment/completed: the recurring payment was confirmed.
  • automatic_pix_payment/error: the recurring payment failed.
  • automatic_pix_payment/canceled: the recurring payment was canceled (by user, expiration or revoked consent).

smart_transfer_preauthorization/ – Smart Transfer pre-authorization (consent setup).

  • smart_transfer_preauthorization/completed: the pre-authorization was accepted.
  • smart_transfer_preauthorization/error: the pre-authorization failed.

smart_transfer_payment/ – Smart Transfer individual payments executed under an active pre-authorization.

  • smart_transfer_payment/completed: the transfer was successful.
  • smart_transfer_payment/error: the transfer failed.
headers
object | null

HTTP headers to include in webhook notifications. Send null to clear the existing headers.

boolean

Re-enable a webhook that was previously disabled. When set to true, clears the disabledAt timestamp.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json