Amo | Integrações
    • Voltar para página inicial
    • Open Delivery
    • Webhook
    • Authenticate a Request
    • Get Access Token
      POST
    • Get Merchant
      GET
    • List Orders
      GET
    • Get Order details
      GET
    • Confirm Order
      POST
    • Ready for Pickup
      POST
    • Picked Up
      POST
    • Dispatch
      POST
    • Delivered
      POST
    • Request Cancellation
      POST

    Webhook

    Recebimento de webhook para atualização de status do pedidos

    Para o recebimento de webhook de atualização de status é necessário entrar em contato com a Amo, informando uma URL POST e uma chave secreta para que sejam feitos os envios. Respostas com status code 20x serão entendidas como recebimento bem sucedido do evento.

    Exemplo de URL

    • POST https://seusite.com/orders/webhook

    Assinatura do envio

    Os disparos de webhook serão assinados usando a chave secreta informada pelo parceiro, a fim de garantir a autenticidade das requisições. A assinatura poderá ser obtida do header { x-signature-id: String }.

    Composição da assinatura

    baseString - ${url}${method}${payload}
    
    https://apitest.com/webhookPOST{"event": "Evento"}
    
    • Após isso, deve ser usada a chave secreta + string base para criar uma assinatura hMac e comparar com a assinatura recebida no webhook.

    Status esperados

    StatusDescrição
    CREATEDPedido criado
    CONFIRMEDPedido confirmado
    DISPATCHEDPedido enviado
    CONCLUDEDPedido concluído
    CANCELEDPedido cancelado

    Formato do evento

    • Body
    {
        eventId: String (id do evento),
        eventType: String (eventos listados acima),
        orderId: String (id do pedido),
        orderURL: https://api.amo.delivery/v1/open-delivery/orders/:order_id,
        createdAt: String (data do pedido, no padrão ISO 8601)
    }
    
    • Headers
    {
        X-App-Id: 'Amo Sistemas',
        X-App-Signature: 'f3bc0cb06bccf656fafcadcc6e3858a634aa5d53497e2179b3fad811a5daaa9b',
        X-App-MerchantId: 'af06a2e3-1bc1-41be-a848-e6e4a4e4191a'
    }
    

    X-App-Id: Identificador Amo
    X-App-MerchantId: Identificador Loja <> Integração
    X-App-Signature: Assinatura de autenticidade Amo

    Modificado em 2026-03-27 12:32:41
    Próxima página
    Authenticate a Request
    Built with