Criando 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, # ID da organização para qual o webhook será criado
    url: "https://meusistema.com/webhooks/assinaturas", # URL que receberá os eventos
    format: JSON, # Pode ser JSON ou URLENCODED
    type: SIGNATURE, # Tipo de objeto monitorado: DOCUMENT, SIGNATURE ou MEMBER
    name: "Webhook Assinaturas", # Nome identificador do webhook
    events: [SIGNATURE_CREATED, SIGNATURE_ACCEPTED], # Lista de eventos que deseja escutar
    folder_id: "c8e96bce-fb65-4f1b-a97d-29df0e8cde94" # (opcional) ID da pasta associada
  ) {
    secret
    webhook_endpoint {
      id
      url
      active
      events
    }
  }
}

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

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