Documentação
HomePainelChaves de API
API Corporativo
API Corporativo
  • Introdução
  • Queries
    • Listando organizações filhas
    • Listando membros de organizações filhas
  • Gerando relatório simples de consumo de organização filha
  • Mutations
    • Gestão de documento
      • Criação de Documento com Dados Pré-Preenchidos dos Signatários
    • Gestão de organizações filhas
      • Criando organização filha
      • Editando organização filha
      • Alterando plano da organização filha
      • Excluindo organização filha
    • Gestão de membros de organizações filhas
      • Criando um membro para uma organização filha
      • Editando um membro de uma organização filha
      • Excluindo membro de uma organização filha
    • Integrando com iframe
      • Gerando token de login para integração por iframe
    • Gestão de endpoints de Webhooks
      • Cadastrnado endpoint para receber webhooks
Fornecido por GitBook
Nesta página

Isto foi útil?

  1. Mutations
  2. Gestão de endpoints de Webhooks

Cadastrnado endpoint para receber webhooks

Como criar um endpoint para receber webhooks para receber webhooks de gatilhos em uma organização filha.

mutation{
  createEndpoint(
    organization_id: 123,
    url: "https://webhook.exemplo.com/endpoint",
    format: JSON,
    type: DOCUMENT,
    name: "Novo endpoint para documentos",
    events: [DOCUMENT_CREATED, DOCUMENT_FINISHED]
  ) {
    secret
    webhook_endpoint{
      id
      has_authorization_token
      url
      name
      active
      blocked
      format
      organization
      events
      block_at
      updated_at
      created_at
      successful_attempts
      failed_attempts
      success_rate
      requires_static_ip
    }
  }
}

Enuns

WebhookFormatEnum

Formato de entrega dos dados:

  • URLENCODED

  • JSON

WebhookEndpointTypeEnum

Categoria do endpoint:

  • DOCUMENT

  • SIGNATURE

  • MEMBER

O tipo selecionado define quais serão os eventos que serão vinculados.

O tipo MEMBER só pode selecionar MEMBER_CREATED, MEMBER_DELETED. Os demais selecionados serão desconsiderado.

WebhookEventTypeEnum

Eventos disponíveis para escuta:

  • DOCUMENT_CREATED

  • DOCUMENT_UPDATED

  • DOCUMENT_DELETED

  • DOCUMENT_FINISHED

  • SIGNATURE_CREATED

  • SIGNATURE_UPDATED

  • SIGNATURE_DELETED

  • SIGNATURE_VIEWED

  • SIGNATURE_ACCEPTED

  • SIGNATURE_REJECTED

  • SIGNATURE_BIOMETRIC_APPROVED

  • SIGNATURE_BIOMETRIC_UNAPPROVED

  • SIGNATURE_BIOMETRIC_REJECTED

  • MEMBER_CREATED

  • MEMBER_DELETED

AnteriorGestão de endpoints de Webhooks

Atualizado há 16 dias

Isto foi útil?

Para saber mais sobre as condições para o gatilhos dos eventos. Está disponíveis em .

webhooks