1. Notificações
SYNC-DOCUMENTATION
  • Introdução
  • Auth Token
    • Gera o token de utilização da aplicação
      POST
  • Saldo
    • Retorna o Saldo do Usuário
      GET
  • Transações
    • Consultar transação V1
      GET
    • Consultar transação V2
      GET
  • Utmify
    • Salvar Token
      POST
    • Desativa Token
      POST
  • Partner
    • Consulta dados do Parceiro
      GET
  • Cartão de Crédito
    • Tokenização pública de cartão
    • IFrame
    • Cobrar no cartão
      POST
  • Pix - CashIn
    • Solicitação de depósito via Pix
      POST
  • Old API
    • CashIn
      POST
    • Consulta os dados do Parceiro
      GET
  • Assinaturas - Recorrência
    • Assinatura com Cartão de Crédito
    • Planos
      • Listar planos
      • Criar plano
      • Detalhe do plano
      • Assinantes do plano
    • Assinantes
      • Cadastrar assinante
      • Listar assinantes
      • Detalhe da assinatura
      • Cancelar assinatura
      • Pausar assinatura
      • Reativar assinatura
      • Trocar plano da assinatura
    • Notificações
      • Listar entregas de um webhook
    • Produtos — Planos
      • Listar planos aninhados a um produto
      • Criar plano aninhado a um produto
      • Marcar plano como padrão do produto
  • Reembolsos
    • Solicitar reembolso de uma venda
    • Consultar uma solicitação de reembolso
  • Webhooks
    • Cash-In
      • Cash-in criado (cobrança PIX gerada)
      • Cash-in atualizado (mudança de status)
      • Cash-in legado (notificação mínima)
    • Cash-Out
      • Cash-out criado (saque solicitado)
      • Cash-out atualizado (mudança de status do saque)
    • Cartão de Crédito
      • Cartão de crédito — cobrança criada
      • Cartão de crédito — mudança de status
    • Transações - Completo
      • Cobrança de transação criada
      • Transação teve mudança de status
    • Listar webhooks
    • Criar webhook
    • Atualizar webhook
    • Excluir webhook
    • Rotacionar o segredo de assinatura
  • Raiz
    • iFrame de pagamento (cartão e Apple Pay)
    • Planos
      • Catálogo do que pode ser cobrado
    • Assinantes
      • Cobranças da assinatura (e as próximas)
    • Notificações
      • Listar webhooks
        GET
      • Criar webhook
        POST
      • Atualizar webhook
        PUT
      • Remover webhook
        DELETE
  • Esquemas
    • Webhook
      • CashIn
        • onCreate
        • onUpdate
        • CashinCreated
        • CashinUpdated
        • CashinOld
      • CashOut
        • onCreate
        • onUpdate
      • Cash-In
        • CashinCreated
        • CashinUpdated
        • CashinOld
    • CashinCreated
    • WebhookInput
    • CardTokenRequest
    • CreditCardPaymentRequest
    • Message
    • RefundReason
    • CreditCardCreated
    • Transaction
    • TransactionEvent
    • BillingMethod
    • CashoutCreated
    • CreditCardCreatePayload
    • RefundStatus
    • CreditCardPaymentAccepted
    • CardToken
    • CreditCardStatusPayload
    • CashinUpdated
    • Webhook
    • CashoutUpdated
    • CreditCardUpdated
    • TransactionV2
    • PlanStatus
    • RefundWebhookPayload
    • RefundRejectionCategory
    • CashinOld
    • Customer
    • CreatedWebhook
    • SplitStatus
    • WebhookListItem
    • DebtorAccount
    • SubscriptionSplit
    • PaymentMethod
    • RefundRequest
    • SimpleError
    • WebhookDelivery
    • SplitRecipientPayload
    • CodedError
    • Payment
    • RotatedWebhookSecret
    • StoreProductPlanRequest
    • PlanResource
    • SubscriptionSplitInvite
    • RefundTransaction
    • Card
    • Checkout
    • UpdateProductPlanRequest
    • RefundEvent
    • RefusedError
    • PlanContext
    • SubscriptionStatus
    • PaymentLink
    • AntiFraudError
    • ChargeStatus
    • PaymentStatus
    • Error
    • SubscriptionSplitItem
    • Tracking
    • ChargeAttemptResource
    • DeliveryAddress
    • UpcomingCharges
    • EnrollTargetRejected
    • PaginationMeta
    • CatalogPlan
    • ProblemJson
    • ChargeResource
    • SubscriptionResource
    • WebhookResource
    • NotFoundError
    • ValidationError
    • EnrollPaymentQrCode
    • EnrollPaymentPixAutomatico
    • ChargeBlock
    • EnrollPaymentCreditCard
    • WebhookDeliveryResource
    • WebhookEnvelope
    • MandateBlock
  1. Notificações

Criar webhook

POST
/api/partner/v1/webhooks
Cria um webhook para receber notificações de eventos de assinatura.
Eventos de assinatura enviados (um webhook por evento):
EventoDescrição
assinatura_criadaAdesão criada
assinatura_ativadaPrimeiro pagamento confirmado; assinatura ativa
assinatura_renovadaCiclo a partir do 2º pago
assinatura_em_atrasoPagamento vencido dentro do grace period
assinatura_suspensaSuspensa por inadimplência ou manualmente
assinatura_reativadaReativada após suspensão
assinatura_canceladaCancelada definitivamente
assinatura_plano_alteradoPlano da assinatura mudou
assinatura_expiradaExpirou
assinatura_completadaChegou ao último ciclo
cobranca_geradaCobrança do ciclo criada
cobranca_pagaCobrança paga
cobranca_falhouCobrança falhou
cobranca_retentativaNova tentativa agendada
mandato_ativado e mandato_cancelado são aceitos no cadastro, mas
hoje não são enviados. O evento all não recebe eventos de
assinatura.
A resposta traz o segredo do webhook em token (só neste momento; para
trocar, POST /webhooks/{id}/rotate-secret). Ele assina cada entrega no
cabeçalho X-Webhook-Signature: sha256=<HMAC-SHA256 do corpo bruto>;
o nome do evento vai em X-Subscription-Event.
A URL configurada receberá um POST com o payload do evento. Certifique-se
de que o endpoint retorne 2xx em até 30 segundos.

Requisição

Authorization
Bearer Token
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
or
Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢201
application/json
Webhook criado com sucesso.
Bodyapplication/json

🟠422
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/partner/v1/webhooks' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "title": "Assinaturas — Produção",
    "url": "https://meusite.com.br/webhooks/syncpay",
    "event": "assinatura_ativada",
    "trigger_all_products": true
}'
Response Response Example
201 - Sucesso
{
    "id": 42,
    "title": "Assinaturas — Produção",
    "url": "https://meusite.com.br/webhooks/syncpay",
    "event": "assinatura_ativada",
    "trigger_all_products": true,
    "products": [],
    "token": "segredo-exemplo-mostrado-uma-vez",
    "created_at": "2026-07-06 10:00:00"
}
Modificado em 2026-10-30 00:52:45
Página anterior
Listar webhooks
Próxima página
Atualizar webhook
Built with