Asaas · Schema

WebhookConfigSaveRequestDTO

Array com as configurações de Webhooks desejadas

PaymentsBillingSubscriptionPixBoletoCredit CardsCheckoutSplit PaymentsWebhookDigital AccountReceivablesInvoicingBrazilFintechSmall Business

Properties

Name	Type	Description
name	string	Nome do Webhook
url	string	URL de destino dos eventos
email	string	E-mail que receberá notificações sobre o Webhook
interrupted	boolean	Definir se a fila de sincronização está interrompida
enabled	boolean	Definir se o Webhook está ativo
authToken	string	Token de autenticação do Webhook
events	array	Lista de eventos enviados pelo Webhook
sendType	object
apiVersion	integer	Versão da API

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/asaas/main/json-schema/asaas-webhook-config-save-request-dto-schema.json",
  "title": "WebhookConfigSaveRequestDTO",
  "description": "Array com as configurações de Webhooks desejadas",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/asaas-asaas-openapi.yml#/components/schemas/WebhookConfigSaveRequestDTO",
  "required": [
    "name",
    "url",
    "email",
    "interrupted",
    "enabled",
    "events",
    "sendType"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Nome do Webhook",
      "nullable": false,
      "deprecated": false
    },
    "url": {
      "type": "string",
      "description": "URL de destino dos eventos",
      "nullable": false,
      "deprecated": false
    },
    "email": {
      "type": "string",
      "description": "E-mail que receberá notificações sobre o Webhook",
      "nullable": false,
      "deprecated": false
    },
    "interrupted": {
      "type": "boolean",
      "description": "Definir se a fila de sincronização está interrompida",
      "nullable": false,
      "deprecated": false
    },
    "enabled": {
      "type": "boolean",
      "description": "Definir se o Webhook está ativo",
      "nullable": false,
      "deprecated": false
    },
    "authToken": {
      "maxLength": 255,
      "minLength": 32,
      "type": "string",
      "description": "Token de autenticação do Webhook",
      "deprecated": false
    },
    "events": {
      "type": "array",
      "description": "Lista de eventos enviados pelo Webhook",
      "nullable": false,
      "deprecated": false,
      "items": {
        "type": "string",
        "description": "Lista de eventos enviados pelo Webhook",
        "deprecated": false,
        "enum": [
          "PAYMENT_AUTHORIZED",
          "PAYMENT_AWAITING_RISK_ANALYSIS",
          "PAYMENT_APPROVED_BY_RISK_ANALYSIS",
          "PAYMENT_REPROVED_BY_RISK_ANALYSIS",
          "PAYMENT_CREATED",
          "PAYMENT_UPDATED",
          "PAYMENT_CONFIRMED",
          "PAYMENT_RECEIVED",
          "PAYMENT_ANTICIPATED",
          "PAYMENT_OVERDUE",
          "PAYMENT_DELETED",
          "PAYMENT_RESTORED",
          "PAYMENT_REFUNDED",
          "PAYMENT_REFUND_IN_PROGRESS",
          "PAYMENT_REFUND_DENIED",
          "PAYMENT_RECEIVED_IN_CASH_UNDONE",
          "PAYMENT_CHARGEBACK_REQUESTED",
          "PAYMENT_CHARGEBACK_DISPUTE",
          "PAYMENT_AWAITING_CHARGEBACK_REVERSAL",
          "PAYMENT_DUNNING_RECEIVED",
          "PAYMENT_DUNNING_REQUESTED",
          "PAYMENT_BANK_SLIP_CANCELLED",
          "PAYMENT_BANK_SLIP_VIEWED",
          "PAYMENT_CHECKOUT_VIEWED",
          "PAYMENT_CREDIT_CARD_CAPTURE_REFUSED",
          "PAYMENT_PARTIALLY_REFUNDED",
          "PAYMENT_SPLIT_CANCELLED",
          "PAYMENT_SPLIT_DIVERGENCE_BLOCK",
          "PAYMENT_SPLIT_DIVERGENCE_BLOCK_FINISHED",
          "PAYMENT_SPLIT_DONE",
          "INVOICE_CREATED",
          "INVOICE_UPDATED",
          "INVOICE_SYNCHRONIZED",
          "INVOICE_AUTHORIZED",
          "INVOICE_PROCESSING_CANCELLATION",
          "INVOICE_CANCELED",
          "INVOICE_CANCELLATION_DENIED",
          "INVOICE_ERROR",
          "TRANSFER_CREATED",
          "TRANSFER_PENDING",
          "TRANSFER_IN_BANK_PROCESSING",
          "TRANSFER_BLOCKED",
          "TRANSFER_DONE",
          "TRANSFER_FAILED",
          "TRANSFER_CANCELLED",
          "BILL_CREATED",
          "BILL_PENDING",
          "BILL_BANK_PROCESSING",
          "BILL_PAID",
          "BILL_CANCELLED",
          "BILL_FAILED",
          "BILL_REFUNDED",
          "RECEIVABLE_ANTICIPATION_CANCELLED",
          "RECEIVABLE_ANTICIPATION_SCHEDULED",
          "RECEIVABLE_ANTICIPATION_PENDING",
          "RECEIVABLE_ANTICIPATION_CREDITED",
          "RECEIVABLE_ANTICIPATION_DEBITED",
          "RECEIVABLE_ANTICIPATION_DENIED",
          "RECEIVABLE_ANTICIPATION_OVERDUE",
          "MOBILE_PHONE_RECHARGE_PENDING",
          "MOBILE_PHONE_RECHARGE_CANCELLED",
          "MOBILE_PHONE_RECHARGE_CONFIRMED",
          "MOBILE_PHONE_RECHARGE_REFUNDED",
          "ACCOUNT_STATUS_BANK_ACCOUNT_INFO_APPROVED",
          "ACCOUNT_STATUS_BANK_ACCOUNT_INFO_AWAITING_APPROVAL",
          "ACCOUNT_STATUS_BANK_ACCOUNT_INFO_PENDING",
          "ACCOUNT_STATUS_BANK_ACCOUNT_INFO_REJECTED",
          "ACCOUNT_STATUS_COMMERCIAL_INFO_APPROVED",
          "ACCOUNT_STATUS_COMMERCIAL_INFO_AWAITING_APPROVAL",
          "ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED",
          "ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON",
          "ACCOUNT_STATUS_COMMERCIAL_INFO_PENDING",
          "ACCOUNT_STATUS_COMMERCIAL_INFO_REJECTED",
          "ACCOUNT_STATUS_DOCUMENT_APPROVED",
          "ACCOUNT_STATUS_DOCUMENT_AWAITING_APPROVAL",
          "ACCOUNT_STATUS_DOCUMENT_PENDING",
          "ACCOUNT_STATUS_DOCUMENT_REJECTED",
          "ACCOUNT_STATUS_GENERAL_APPROVAL_APPROVED",
          "ACCOUNT_STATUS_GENERAL_APPROVAL_AWAITING_APPROVAL",
          "ACCOUNT_STATUS_GENERAL_APPROVAL_PENDING",
          "ACCOUNT_STATUS_GENERAL_APPROVAL_REJECTED",
          "SUBSCRIPTION_CREATED",
          "SUBSCRIPTION_UPDATED",
          "SUBSCRIPTION_INACTIVATED",
          "SUBSCRIPTION_DELETED",
          "SUBSCRIPTION_SPLIT_DISABLED",
          "SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK",
          "SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK_FINISHED",
          "CHECKOUT_CREATED",
          "CHECKOUT_CANCELED",
          "CHECKOUT_EXPIRED",
          "CHECKOUT_PAID",
          "BALANCE_VALUE_BLOCKED",
          "BALANCE_VALUE_UNBLOCKED",
          "INTERNAL_TRANSFER_CREDIT",
          "INTERNAL_TRANSFER_DEBIT",
          "ACCESS_TOKEN_CREATED",
          "ACCESS_TOKEN_DELETED",
          "ACCESS_TOKEN_DISABLED",
          "ACCESS_TOKEN_ENABLED",
          "ACCESS_TOKEN_EXPIRED",
          "ACCESS_TOKEN_EXPIRING_SOON",
          "PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CREATED",
          "PIX_AUTOMATIC_RECURRING_AUTHORIZATION_ACTIVATED",
          "PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED",
          "PIX_AUTOMATIC_RECURRING_AUTHORIZATION_EXPIRED",
          "PIX_AUTOMATIC_RECURRING_AUTHORIZATION_REFUSED",
          "PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CREATED",
          "PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_SCHEDULED",
          "PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_REFUSED",
          "PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CANCELLED",
          "PIX_AUTOMATIC_RECURRING_ELIGIBILITY_UPDATED"
        ]
      },
      "enum": [
        "PAYMENT_AUTHORIZED",
        "PAYMENT_AWAITING_RISK_ANALYSIS",
        "PAYMENT_APPROVED_BY_RISK_ANALYSIS",
        "PAYMENT_REPROVED_BY_RISK_ANALYSIS",
        "PAYMENT_CREATED",
        "PAYMENT_UPDATED",
        "PAYMENT_CONFIRMED",
        "PAYMENT_RECEIVED",
        "PAYMENT_ANTICIPATED",
        "PAYMENT_OVERDUE",
        "PAYMENT_DELETED",
        "PAYMENT_RESTORED",
        "PAYMENT_REFUNDED",
        "PAYMENT_REFUND_IN_PROGRESS",
        "PAYMENT_REFUND_DENIED",
        "PAYMENT_RECEIVED_IN_CASH_UNDONE",
        "PAYMENT_CHARGEBACK_REQUESTED",
        "PAYMENT_CHARGEBACK_DISPUTE",
        "PAYMENT_AWAITING_CHARGEBACK_REVERSAL",
        "PAYMENT_DUNNING_RECEIVED",
        "PAYMENT_DUNNING_REQUESTED",
        "PAYMENT_BANK_SLIP_CANCELLED",
        "PAYMENT_BANK_SLIP_VIEWED",
        "PAYMENT_CHECKOUT_VIEWED",
        "PAYMENT_CREDIT_CARD_CAPTURE_REFUSED",
        "PAYMENT_PARTIALLY_REFUNDED",
        "PAYMENT_SPLIT_CANCELLED",
        "PAYMENT_SPLIT_DIVERGENCE_BLOCK",
        "PAYMENT_SPLIT_DIVERGENCE_BLOCK_FINISHED",
        "PAYMENT_SPLIT_DONE",
        "INVOICE_CREATED",
        "INVOICE_UPDATED",
        "INVOICE_SYNCHRONIZED",
        "INVOICE_AUTHORIZED",
        "INVOICE_PROCESSING_CANCELLATION",
        "INVOICE_CANCELED",
        "INVOICE_CANCELLATION_DENIED",
        "INVOICE_ERROR",
        "TRANSFER_CREATED",
        "TRANSFER_PENDING",
        "TRANSFER_IN_BANK_PROCESSING",
        "TRANSFER_BLOCKED",
        "TRANSFER_DONE",
        "TRANSFER_FAILED",
        "TRANSFER_CANCELLED",
        "BILL_CREATED",
        "BILL_PENDING",
        "BILL_BANK_PROCESSING",
        "BILL_PAID",
        "BILL_CANCELLED",
        "BILL_FAILED",
        "BILL_REFUNDED",
        "RECEIVABLE_ANTICIPATION_CANCELLED",
        "RECEIVABLE_ANTICIPATION_SCHEDULED",
        "RECEIVABLE_ANTICIPATION_PENDING",
        "RECEIVABLE_ANTICIPATION_CREDITED",
        "RECEIVABLE_ANTICIPATION_DEBITED",
        "RECEIVABLE_ANTICIPATION_DENIED",
        "RECEIVABLE_ANTICIPATION_OVERDUE",
        "MOBILE_PHONE_RECHARGE_PENDING",
        "MOBILE_PHONE_RECHARGE_CANCELLED",
        "MOBILE_PHONE_RECHARGE_CONFIRMED",
        "MOBILE_PHONE_RECHARGE_REFUNDED",
        "ACCOUNT_STATUS_BANK_ACCOUNT_INFO_APPROVED",
        "ACCOUNT_STATUS_BANK_ACCOUNT_INFO_AWAITING_APPROVAL",
        "ACCOUNT_STATUS_BANK_ACCOUNT_INFO_PENDING",
        "ACCOUNT_STATUS_BANK_ACCOUNT_INFO_REJECTED",
        "ACCOUNT_STATUS_COMMERCIAL_INFO_APPROVED",
        "ACCOUNT_STATUS_COMMERCIAL_INFO_AWAITING_APPROVAL",
        "ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED",
        "ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON",
        "ACCOUNT_STATUS_COMMERCIAL_INFO_PENDING",
        "ACCOUNT_STATUS_COMMERCIAL_INFO_REJECTED",
        "ACCOUNT_STATUS_DOCUMENT_APPROVED",
        "ACCOUNT_STATUS_DOCUMENT_AWAITING_APPROVAL",
        "ACCOUNT_STATUS_DOCUMENT_PENDING",
        "ACCOUNT_STATUS_DOCUMENT_REJECTED",
        "ACCOUNT_STATUS_GENERAL_APPROVAL_APPROVED",
        "ACCOUNT_STATUS_GENERAL_APPROVAL_AWAITING_APPROVAL",
        "ACCOUNT_STATUS_GENERAL_APPROVAL_PENDING",
        "ACCOUNT_STATUS_GENERAL_APPROVAL_REJECTED",
        "SUBSCRIPTION_CREATED",
        "SUBSCRIPTION_UPDATED",
        "SUBSCRIPTION_INACTIVATED",
        "SUBSCRIPTION_DELETED",
        "SUBSCRIPTION_SPLIT_DISABLED",
        "SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK",
        "SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK_FINISHED",
        "CHECKOUT_CREATED",
        "CHECKOUT_CANCELED",
        "CHECKOUT_EXPIRED",
        "CHECKOUT_PAID",
        "BALANCE_VALUE_BLOCKED",
        "BALANCE_VALUE_UNBLOCKED",
        "INTERNAL_TRANSFER_CREDIT",
        "INTERNAL_TRANSFER_DEBIT",
        "ACCESS_TOKEN_CREATED",
        "ACCESS_TOKEN_DELETED",
        "ACCESS_TOKEN_DISABLED",
        "ACCESS_TOKEN_ENABLED",
        "ACCESS_TOKEN_EXPIRED",
        "ACCESS_TOKEN_EXPIRING_SOON",
        "PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CREATED",
        "PIX_AUTOMATIC_RECURRING_AUTHORIZATION_ACTIVATED",
        "PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED",
        "PIX_AUTOMATIC_RECURRING_AUTHORIZATION_EXPIRED",
        "PIX_AUTOMATIC_RECURRING_AUTHORIZATION_REFUSED",
        "PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CREATED",
        "PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_SCHEDULED",
        "PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_REFUSED",
        "PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CANCELLED",
        "PIX_AUTOMATIC_RECURRING_ELIGIBILITY_UPDATED"
      ]
    },
    "sendType": {
      "$ref": "#/$defs/WebhookConfigSaveRequestWebhookSendType"
    },
    "apiVersion": {
      "type": "integer",
      "description": "Versão da API",
      "format": "int32",
      "deprecated": false
    }
  },
  "deprecated": false,
  "$defs": {
    "WebhookConfigSaveRequestWebhookSendType": {
      "type": "string",
      "description": "Sequencial (SEQUENTIALLY) ou não sequencial (NON_SEQUENTIALLY)",
      "nullable": false,
      "deprecated": false,
      "enum": [
        "NON_SEQUENTIALLY",
        "SEQUENTIALLY"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/asaas-webhook-config-save-request-dto"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.