Webhooks permitem que você se inscreva em eventos que o Shippify gera toda vez que uma entrega ou rota é alterada. Quando um desses eventos é acionado, enviaremos uma solicitação POST HTTP para a URL configurada do webhook.
Configuração de Webhook
Declarando um Webhook
Em sua conta Shippify, vá para o menu esquerdo, escolha a seção Automações, procure por "Push Webhook" no menu lateral esquerdo e pressione o botão "CRIAR AUTOMAÇÃO +".
Escolha as regras para a execução da sua automação. Você precisa escolher o escopo no qual a automação funcionará, o evento que acionará a automação e condições extras, se necessário.
Defina os parâmetro necessários para a automação por webhook.
Parâmetro
Descrição
Mandatório
Payload Key
Webhook
URL para onde o payload do evento será enviado.
HTTP Method
Método de Requisição HTTP para enviar o payload.
Proof of delivery
Caso o evento tenha imagens anexadas, escolha se deseja incluí-las em seu payload.
images (Array[])
HTTP Headers
Cabeçalhos personalizados para a Requisição HTTP.
Recipient's signature
Anexe a assinatura do destinatário como uma imagem PNG com fundo transparente.
signature (String)
Base64 format
As imagens do comprovante de entrega ou assinatura são enviadas no formato base64. (Se desmarcar, então será uma URL).
images/signature
(base64 Array[]/String)
Tracking Url
Inclui URL de rastreamento privado da entrega.
trackingUrl (String)
Nesta seção, você pode gerenciar as URLs que declara para cada um dos eventos aos quais deseja se inscrever. Você também pode testar seus webhooks nesta seção e receberá um payload de exemplo.
Eventos disponíveis por Webhook
Especificações dos eventos disponíveis por webhooks.
Nome
Descrição
Delivery is created
Dispara sempre que uma nova entrega é criada.
Delivery is in transit
Dispara quando uma entrega foi coletada e está em trânsito.
Delivery completed
Dispara quando uma entrega foi entregue.
Delivery returned
Dispara quando uma entrega foi devolvida à origem.
Delivery canceled
Dispara quando uma entrega foi cancelada por um operador.
Deliver Hold By Courier
Dispara quando uma entrega está sendo retida pelo entregador por motivos como a impossibilidade de entregar o pacote. Nesse caso, você encontrará o motivo no parâmetro de notas do payload.
Payload do evento
Quando um dos eventos listados anteriormente é concluído, o webhook é executado e envia o seguinte payload:
Entrega criada com sucesso
Parâmetro
Valor
Webhook
www.webhooktest.com
HTTP Method
POST
{"id":"t-xyz-123","routeId": null,"networkId": 225,"networkName": "Default-company test","jobId": null,"blocked": false,"cityId": 2,"cityName": "Guayaquil","cityLang": "es","companyId": 1,"companyName": "Shippify Inc.","companyPlanType": "postpaid","companyParentId": 1,"companyMode": 0,"shipperId": null,"type": "flex","vehicleCapacity": 2,"price": 2.75,"scheduledStartPickingDate": "2021-06-23T18:00:00.000Z","scheduledEndPickingDate": "2021-06-23T19:00:00.000Z","arrivalPickupDate": null,"scheduledStartDeliveryDate": "2021-06-23T19:00:00.000Z","scheduledEndDeliveryDate": "2021-06-24T00:00:00.000Z","arrivalDeliveryDate": null,"creationDate": "2021-06-22T20:51:27.000Z","pickupDueDate": null,"deliveryDueDate": null,"pickingPlace":{"lat":-2.1594806,"lng":-79.895742599,"originalAddress":"torres del norte, av. 9, guayaquil 090512, ecuador","address":"torres del norte, av. 9, guayaquil 090512, ecuador" },"droppingPlace":{"lat":-2.1693477,"lng":-79.8985397,"originalAddress":"san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador","address":"san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador" },"recipientInfo":{"name":"Test recipient","email":"testrecip@test.com" },"senderInfo":{"name":"Test sender","email":"testsender@test.com" },"state": 1,"tags": null,"items":[ {"name":"1","qty":1,"size":"S","price":0,"weight":0,"fragile":false,"pickedUp":false,"delivered":false } ],"referenceId": "referenceId","notes": null,"attempts": 0,"countryCode": "EC","countryName": "ECUADOR","currencyCode": "USD","formulaId": "815","cash": 0,"distance": 1.7999999523162842,"distanceRoute": 1.7999999523162842,"eventEntity": "delivery","eventDate": "2021-06-22T20:51:27+00:00","itemsNumber": 1,"itemsWeight": 0,"itemsPrice": 0,"dbId": 214280954,"eventType": "DELIVERY_CREATED_SUCCESSFULLY","eventCreatedAt": "2021-06-22 20:51:27","eventDescription": "Delivery was created successfully","status": "processing","eventId": 1624395087667}
Entrega retida pelo entregador
Parâmetro
Valor
Webhook
www.webhooktest.com
HTTP Method
POST
Tracking URL
{"id":"t-xyz-123","routeId":null,"networkId":25,"networkName":"Default-company test","jobId":null,"blocked":false,"cityId":2,"cityName":"Guayaquil","cityLang":"es","companyId":1,"companyName":"company test","companyPlanType":"postpaid","companyParentId":1,"companyMode":1,"shipperId":null,"shipperMobile":null,"type":"slot","vehicleCapacity":3,"vehicleId":null,"price":0,"insurance":0,"scheduledStartPickingDate":"2024-01-08T17:27:20.000Z","scheduledEndPickingDate":"2024-01-08T17:57:20.000Z","effectivePickupDate":"2024-01-08T16:33:44.000Z","arrivalPickupDate":null,"scheduledStartDeliveryDate":"2024-01-08T18:12:20.000Z","scheduledEndDeliveryDate":"2024-01-08T18:42:20.000Z","effectiveDeliveryDate":"2024-01-08T17:27:07.000Z","arrivalDeliveryDate":null,"creationDate":"2024-01-08T16:27:21.000Z","pickupDueDate":null,"deliveryDueDate":null,"pickingPlace":{"lat":-2.1594806,"lng":-79.895742599,"originalAddress":"torres del norte, av. 9, guayaquil 090512, ecuador","address":"torres del norte, av. 9, guayaquil 090512, ecuador" },"droppingPlace":{"lat":-2.1693477,"lng":-79.8985397,"originalAddress":"san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador","address":"san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador" },"recipientInfo":{"name":"Test recipient","email":"testrecip@test.com" },"senderInfo":{"name":"Test sender","email":"testsender@test.com" },"senderInfoDecoded": {"name":"Test","email":"test@test.com","phonenumber":"11111111" },"receiverInfoDecoded": {"name":"Siham","email":"","phonenumber":"" },"state":6,"tags":null,"items": [ {"id":"","uuid":"bb3ef06e-647d-412b-92d1-293de6f5ce76","name":"caixa","size":"S","price":0,"weight":0,"pickedUp":true,"delivered":true,"sid":"t-shippify2-40254_3","scanned":false,"qty":62 } ],"referenceId":"test1234","notes":"{\"reason\":\"ADDRESS NOT FOUND, NEED CHANGE\",\"reasonId\":11,\"comment\":\"test\"}","notesJson": {"reason":"ADDRESS NOT FOUND, NEED CHANGE","reasonId":11,"comment":"test" },"attempts":1,"countryCode":"EC","countryName":"ECUADOR","currencyCode":"USD","formulaId":"1234","cash":0,"distance":305.6000061035156,"distanceRoute":0,"distanceCharged":0,"totalPackagePrice":0,"eventEntity":"delivery","eventDate":"2024-01-08T20:38:55+00:00","lastEventParams": {"author": {"type":"client","id":1234,"name":"Client Name","email":"client@mail.com" },"method":"UPDATE_ROUTE_STATUS","timestamp":1704746335 },"colleted":0,"paid":0,"statusUpdateDate":null,"partial":0,"itemsNumber":62,"itemsWeight":0,"itemsPrice":0,"references": [],"incidences": [],"cityDepartment":null,"metadata": {"previousStatus":"processing" },"previousStatus":"processing","dbId":948182101,"eventType":"DELIVERY_HOLD_BY_COURIER","eventAuthor": {"type":"client","id":1234,"name":"Client Name","email":"client@mail.com" },"eventCreatedAt":"2024-01-08 20:38:55","eventDescription":"Delivery is hold by courier (previous status was completed)","eventParams":"{\"method\":\"UPDATE_ROUTE_STATUS\"}","status":"hold_by_courier","eventId":1704746335377,"trackingUrl":"https://api.shippify.co/track/t-xyz-123?token={token}"}
Entrega completa
Parâmetro
Valor
Webhook
www.webhooktest.com
HTTP Method
POST
Proof of delivery
Recipient's signature
{"id":"t-xyz-123","routeId":null,"networkId":25,"networkName":"Default-company test","jobId":null,"blocked":false,"cityId":2,"cityName":"Guayaquil","cityLang":"es","companyId":1,"companyName":"company test","companyPlanType":"postpaid","companyParentId":1,"companyMode":1,"shipperId":null,"shipperMobile":null,"type":"slot","vehicleCapacity":3,"vehicleId":null,"price":0,"insurance":0,"scheduledStartPickingDate":"2024-01-08T17:27:20.000Z","scheduledEndPickingDate":"2024-01-08T17:57:20.000Z","effectivePickupDate":"2024-01-08T16:33:44.000Z","arrivalPickupDate":null,"scheduledStartDeliveryDate":"2024-01-08T18:12:20.000Z","scheduledEndDeliveryDate":"2024-01-08T18:42:20.000Z","effectiveDeliveryDate":"2024-01-08T17:27:07.000Z","arrivalDeliveryDate":null,"creationDate":"2024-01-08T16:27:21.000Z","pickupDueDate":null,"deliveryDueDate":null,"pickingPlace":{"lat":-2.1594806,"lng":-79.895742599,"originalAddress":"torres del norte, av. 9, guayaquil 090512, ecuador","address":"torres del norte, av. 9, guayaquil 090512, ecuador" },"droppingPlace":{"lat":-2.1693477,"lng":-79.8985397,"originalAddress":"san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador","address":"san marino shopping, av. francisco de orellana, guayaquil 090512, ecuador" },"recipientInfo":{"name":"Test recipient","email":"testrecip@test.com" },"senderInfo":{"name":"Test sender","email":"testsender@test.com" },"senderInfoDecoded": {"name":"Test sender","email":"testsender@test.com" },"receiverInfoDecoded": {"name":"Test recipient","email":"testrecip@test.com" },"state":7,"tags":null,"items": [ {"id":"","uuid":"bb3ef06e-647d-412b-92d1-293de6f5ce76","name":"caixa","size":"S","price":0,"weight":0,"pickedUp":true,"delivered":true,"sid":"t-shippify2-40254_3","scanned":false,"qty":62 } ],"referenceId":"test1234","notes":"{\"comment\":\"test\"}","attempts":0,"countryCode":"EC","countryName":"ECUADOR","currencyCode":"USD","formulaId":"1234","cash":0,"distance":305.6000061035156,"distanceRoute":0,"distanceCharged":0,"totalPackagePrice":0,"eventEntity":"delivery","eventDate":"2024-01-08T17:27:08+00:00","lastEventParams": {"author": {"type":"client","id":2534,"name":"Denny K. Saas","email":"denny2@shippify.co" },"method":"UPDATE_ROUTE_STATUS","timestamp":1704734827 },"colleted":0,"paid":0,"statusUpdateDate":null,"partial":0,"notesJson": {"comment":"test" },"itemsNumber":62,"itemsWeight":0,"itemsPrice":0,"references": [],"incidences": [],"cityDepartment":null,"metadata": {"previousStatus":"processing" },"previousStatus":"processing","dbId":948182094,"eventType":"DELIVERY_COMPLETED","eventAuthor": {"type":"client","id":2534,"name":"Denny K. Saas","email":"denny2@shippify.co" },"eventCreatedAt":"2024-01-08 17:27:07","eventDescription":"Delivery was completed (previous status was processing)","eventParams":"{\"method\":\"UPDATE_ROUTE_STATUS\"}","status":"completed","eventId":1704734828038,"images": ["https://cdn.dev.shippify.co/delivery-files/77030821377477563003dde3ce5.jpg"],"signature":"https://cdn.dev.shippify.co/delivery-files/16839098636794LPh1Zd7S5Goc9BvmQyG7BpT6asb.png"}
