Visão Geral

A plataforma e-Procurement do Mercado Eletrônico oferece o recurso de WebHooks para que possamos interagir com os eventos que ocorrem na plataforma.

❗️ Atenção

Por favor, consulte a página Webhooks na seção de Guias para verificar as primeiras informações sobre os webhooks antes de prosseguir nesta página.

Você pode usar assinaturas de webhook para receber notificações sobre eventos específicos.

Tópicos

Evento	Tópico	Descrição
Pedido Recebido	order.received	Ocorre quando você recebe um pedido na plataforma.
Pedido Criado	order.created	Ocorre quando você cria um pedido na plataforma.
Pedido Cancelado	order.canceled	Ocorre quando um pedido é cancelado na plataforma.
Pedido Entregue	order.delivered	Ocorre quando uma entrega de pedido é criada.
Pedido Atualizado	order.updated	Ocorre quando um pedido é atualizado.
Requisição Aprovada	request.approved	Ocorre quando uma requisição é aprovada na plataforma.
Status da Requisição	request.status	Ocorre toda vez que o status do documento muda.
Status do item da Requisição	request-item.status.updated	Ocorre toda vez que o status do item da requisição é atualizado.
RFQ Criado	rfq.created	Ocorre quando um RFQ é criado na plataforma.
RFQ Fechado	rfq.closed	Ocorre quando um RFQ é fechado na plataforma.
RFQ Expirado	rfq.expired	Ocorre quando um RFQ é expirado na plataforma.
RFQ Cancelado	rfq.canceled	Ocorre quando um RFQ é cancelado na plataforma.
RFQ Atualizado	rfq.updated	Ocorre quando um RFQ é atualizado na plataforma.
RFQ - Criação da resposta	rfq.answer.created	Ocorre quando uma resposta de cotação é criada na plataforma.
RFQ - Atualização da resposta	rfq.answer.updated	Ocorre quando uma resposta de cotação é atualizada na plataforma.
Pré-Pedido Criado	preorder.created	Ocorre quando um pré-pedido é criado na plataforma.
Pré-Pedido Aprovado	preorder.approved	Ocorre quando um pré-pedido é aprovado na plataforma.
Status do Pré-Pedido	preorder.status	Ocorre toda vez que o status do documento muda.
Folha de Serviço Criada	service-sheet.created	Ocorre quando uma folha de serviço é criada na plataforma.
Folha de Serviço Aprovada	service-sheet.approved	Ocorre quando uma folha de serviço é aprovada na plataforma.
Status da Folha de Serviço	service-sheet.status	Ocorre toda vez que o status do documento muda.
Contrato Criado	contract.created	Ocorre quando um contrato é criado na plataforma.
Status do Contrato	contract.status	Ocorre toda vez que o status do documento muda.
Status da Nota Fiscal	invoice.status	Ocorre toda vez que o status do documento muda.
Nota Fiscal Criada	invoice.created	Ocorre quando uma Nota Fiscal é criada.
Nota Fiscal Atualizada	invoice.updated	Ocorre quando uma Nota Fiscal é atualizada na plataforma.
Anexo de Nota Fiscal Criado	invoice.attachment.created	Ocorre quando um novo anexo é enviado.
Anexo de Nota Fiscal Excluído	invoice.attachment.deleted	Ocorre quando um anexo é excluído.
Fornecedor Criado	supplier.created	Ocorre quando você cria um fornecedor na plataforma.
Fornecedor Atualizado	supplier.updated	Ocorre quando um fornecedor é atualizado na plataforma.
Fornecedor - Aprovação Pendente	supplier.approval.pending	Ocorre quando uma homologação é necessária.
Fornecedor Aprovado	supplier.approved	Ocorre quando uma homologação é aprovada.
Resultado da Integração	integration.result	Ocorre quando uma solicitação de integração é concluída na plataforma.

Estes são alguns exemplos de resposta que você pode consumir para cada tópico descrito acima:

Pedido Recebido

{
  "topic": "order.received",
  "data": {
    "orderId": "123",
    "clientId": "456",
    "supplierId": "789"
  }
}

Pedido Criado

{
  "topic": "order.created",
  "data": {
    "orderId": "123"
  }
}

Pedido Cancelado

{
  "topic": "order.canceled",
  "data": {
    "orderId": "123",
    "customerId": "456",
    "supplierId": "789"
  }
}

Pedido Entregue

{
  "topic": "order.delivered",
  "data": {
    "deliveryId": "55421",
    "orderId": "12442",
    "orderItemId": "1"
  }
}

Pedido Atualizado

{
  "topic": "order.updated",
  "data": {
    "orderId": "123",
    "customerId": "456",
    "supplierId": "789"
  }
}

Folha de Serviço Criada

{
  "topic": "service-sheet.created",
  "data": {
    "serviceSheetId": "32211"
  }
}

Folha de Serviço Aprovada

{
  "topic": "service-sheet.approved",
  "data": {
    "serviceSheetId": "32211"
  }
}

Status da Folha de Serviço

{
  "topic": "service-sheet.status",
  "data": {
    "serviceSheetId": "32211",
    "status": "103",
    "previousStatus": "101"
  }
}

Requisição Aprovada

{
  "topic": "request.approved",
  "data": {
    "requestId": "55331112"
  }
}

Status da Requisição

{
  "topic": "request.status",
  "data": {
    "requestId": "32211",
    "status": "103",
    "previousStatus": "101"
  }
}

Status do item da Requisição

{
    "topic":
    "request-item.status.updated",
    "data": {
        "requestId": "38510943",
        "requestItemId": "5"
    }
}

Pré-Pedido Criado

{
  "topic": "preorder.created",
  "data": {
    "preOrderId": "331123",
     "customerId": "456",
  }
}

Pré-Pedido Aprovado

{
  "topic": "preorder.approved",
  "data": {
    "preOrderId": "331123"
  }
}

Status de Pré-Pedido

{
  "topic": "preorder.status",
  "data": {
    "preOrderId": "32211",
    "status": "103",
    "previousStatus": "101"
  }
}

RFQ Criada

{
  "topic": "rfq.created",
  "data": {
    "rfqId": "4331"
  }
}

RFQ Encerrada

{
  "topic": "rfq.closed",
  "data": {
    "rfqId": "4331"
  }
}

RFQ Expirada

{
  "topic": "rfq.expired",
  "data": {
    "rfqId": "4331"
  }
}

RFQ Cancelada

{
  "topic": "rfq.canceled",
  "data": {
    "rfqId": "4331"
  }
}

RFQ Atualizada

{
  "topic": "rfq.updated",
  "data": {
    "rfqId": "4331"
  }
}

RFQ - Criação da resposta

{
    "topic":
    "rfq.answer.created",
    "data": {
        "rfqId": "9149480",
        "supplierId": "5380963",
        "clinteSupplierId": "0004970001"
    }
}

RFQ - Atualização da resposta

{
    "topic":
    "request-item.status.updated",
    "data": {
        "requestId": "38510943",
        "requestItemId": "5"
    }
}

Status de Nota Fiscal

{
  "topic": "invoice.status",
  "data": {
    "invoiceId": "32211",
    "status": "103",
    "previousStatus": "101"
  }
}

Nota Fiscal Criada

{
  "topic": "invoice.created",
  "data": {
    "invoiceId": "32211"
  }
}

Nota Fiscal Atualizada

{
  "topic": "invoice.updated",
  "data": {
    "invoiceId": "32211"
  }
}

Anexo de Nota Fiscal Criado

{
  "topic": "invoice.attachment.created",
  "data": {
    "invoiceId": "32211",
    "attachmentId": "54421"
  }
}

Anexo de Nota Fiscal excluído

{
  "topic": "invoice.attachment.deleted",
  "data": {
    "invoiceId": "32211",
    "attachmentId": "54421"
  }
}

Contrato Criado

{
  "topic": "contract.created",
  "data": {
    "contractId": "32211"
  }
}

Status de Contrato

{
  "topic": "contract.status",
  "data": {
    "contractId": "32211",
    "status": "103",
    "previousStatus": "101"
  }
}

Fornecedor Criado

{
  "topic": "supplier.created",
  "data": {
    "supplierId": "54421"
  }
}

Fornecedor Atualizado

{
  "topic": "supplier.updated",
  "data": {
    "supplierId": "32111"
  }
}

Fornecedor Aprovado

{
  "topic": "supplier.approved",
  "data": {
    "supplierId": "32111"
  }
}

Fornecedor com Aprovação Pendente

{
  "topic": "supplier.approval.pending",
  "data": {
    "supplierId": "32111"
  }
}

Resultado de Integração

{
  "topic": "integration.result",
  "data": {
    "correlationId": "YOUR_CORRELATION_ID", // The Request Id, Maybe your internal code
    "resource": "order",
    "identifier": "3211", // Internal ID
    "statusCode": 201,
    "message": "Order 3211 created successfully."
  } 
}