Skip to content

Demandas (Requisitions)

O domínio REQUISITION envia os eventos de webhook para atualizações ocorridas dentro de uma Demanda.

Eventos Disponíveis

  • REQUISITION_WAS_OPENED
  • REQUISITION_WAS_DELETED
  • REQUISITION_WAS_CLOSED
  • REQUISITION_STATUS_WAS_UPDATED
  • REQUISITION_WAS_REOPENED
  • REQUISITION_ASSIGNEE_WAS_UPDATED

Nota: Em todos os eventos de webhook despachados pelo sistema, o campo eventType sempre receberá o sufixo _WEBHOOK (ex: REQUISITION_WAS_OPENED_WEBHOOK).


REQUISITION_WAS_OPENED

Enviado quando uma demanda é criada/aberta na sua organização. O payload deste evento carrega a demanda detalhada (RequisitionWebhook).

Exemplo de Payload

json
{
  "__typename": "WebhookEvent",
  "eventType": "REQUISITION_WAS_OPENED_WEBHOOK",
  "domain": "REQUISITION",
  "organizationId": "5e9f8f8f-8f8f-8f8f-8f8f-8f8f8f8f8f8f",
  "actor": {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "joao.silva@empresa.com",
    "name": "João Silva"
  },
  "requisition": {
    "__typename": "RequisitionWebhook",
    "id": "c76b9d62-628d-429a-9e12-8e798e167e41",
    "createdAt": "2023-10-25T14:30:00.000Z",
    "updatedAt": "2023-10-25T14:30:00.000Z",
    "organizationId": "5e9f8f8f-8f8f-8f8f-8f8f-8f8f8f8f8f8f",
    "requesterId": "123e4567-e89b-12d3-a456-426614174000",
    "assigneeId": null,
    "formId": "d1c2b3a4-5678-90ab-cdef-1234567890ab",
    "slaDate": "2023-10-27T14:30:00.000Z",
    "slaStatus": "ON_TIME",
    "statusId": "2b3c4d5e-6f7g-8h9i-0j1k-2l3m4n5o6p7q",
    "statusCategory": "TODO",
    "status": {
      "id": "2b3c4d5e-6f7g-8h9i-0j1k-2l3m4n5o6p7q",
      "label": "Em Análise",
      "statusCategoryId": "TODO"
    },
    "createdExternally": false
  }
}

Outros Eventos de Demandas

Todos os demais eventos (REQUISITION_WAS_DELETED, REQUISITION_WAS_CLOSED, REQUISITION_STATUS_WAS_UPDATED, REQUISITION_WAS_REOPENED, REQUISITION_ASSIGNEE_WAS_UPDATED) enviam um objeto de demanda resumido (ShortRequisitionWebhook).

O evento REQUISITION_ASSIGNEE_WAS_UPDATED_WEBHOOK inclui campos adicionais informando o responsável antigo e o novo.

Exemplo de Payload para Atualização de Status

json
{
  "__typename": "WebhookEvent",
  "eventType": "REQUISITION_STATUS_WAS_UPDATED_WEBHOOK",
  "domain": "REQUISITION",
  "organizationId": "5e9f8f8f-8f8f-8f8f-8f8f-8f8f8f8f8f8f",
  "actor": {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "joao.silva@empresa.com",
    "name": "João Silva"
  },
  "requisition": {
    "__typename": "ShortRequisitionWebhook",
    "id": "c76b9d62-628d-429a-9e12-8e798e167e41",
    "createdAt": "2023-10-25T14:30:00.000Z",
    "status": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "label": "Concluído",
      "statusCategoryId": "DONE"
    }
  }
}

Exemplo de Payload para Atualização de Responsável (Assignee)

json
{
  "__typename": "WebhookEvent",
  "eventType": "REQUISITION_ASSIGNEE_WAS_UPDATED_WEBHOOK",
  "domain": "REQUISITION",
  "organizationId": "5e9f8f8f-8f8f-8f8f-8f8f-8f8f8f8f8f8f",
  "actor": {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "joao.silva@empresa.com",
    "name": "João Silva"
  },
  "previousAssignee": {
    "id": "11111111-2222-3333-4444-555555555555",
    "name": "Antigo Responsável",
    "email": "antigo@empresa.com"
  },
  "currentAssignee": {
    "id": "99999999-8888-7777-6666-555555555555",
    "name": "Novo Responsável",
    "email": "novo@empresa.com"
  },
  "requisition": {
    "__typename": "ShortRequisitionWebhook",
    "id": "c76b9d62-628d-429a-9e12-8e798e167e41",
    "createdAt": "2023-10-25T14:30:00.000Z",
    "status": {
      "id": "2b3c4d5e-6f7g-8h9i-0j1k-2l3m4n5o6p7q",
      "label": "Em Análise",
      "statusCategoryId": "TODO"
    }
  }
}