Home

WebHook

🚧

Do you have questions about our APIs?
If you need help, don’t forget to use our artificial intelligence — it will help you generate examples that fit your specific needs, variations, and the required parameters for using each Hound Express API.

Request for Sabueso APP to use your Webhook
If you need the Sabueso system to notify your system of any change in status in some of the processes that it consumes from our system, you can do so through a Webhook. How does a webhook work?

Webhooks are user-defined http request submissions that are triggered by specific events. For webhooks to work, it is necessary to register a URL to notify you each time an event occurs. The path created must contain the logic that will be executed once the event occurs.

When the Sabueso system responds from the webhook it returns the following:

📘

## REQUEST

Guide Status

Field Name

Type

Comment

Format

MaxLength

location

String

This value contains the location of the user.

50

observations

String

This value explains the reason for the status change.

500

statusObj

Object

For more details see the StatusObj table.

value

String

This value is a guide number

30

date

String

This value contains the date of change in UTC-06:00.

dd/MM/yyyy HH:mm

dateTime

String

This value contains the date of change in UTC-06:00.

yyyy-MM-dd HH:mm:ss

POD

ByteArray

This byte array value to attachment if exist

POD_B64

String

This base 64 value to attachment if exist

POD_fileName

String

This value to attachment if exist

200

dateTimeISO

String

This value contains the date in the format yyyy-MM-dd'T'HH:mm:ssXXX corresponding to ISO 8601

yyyy-MM-dd'T'HH:mm:ssXXX

Status Obj

Field Name

Type

Comments

MaxLength

id

Integer

This value contains the id of the state.

code

String

This value contain the prefix of the state .

12

description

String

This value contain the description Spanish of the state.

50

description_en

String

This value contain the description English of the state.

50

long_description

String

This value contain the long description Spanish of the state.

500

long_description_en

String

This value contain the long description English of the state.

500

👍

JSON example:

{  
    "dateTime": "2024-04-03 14:57:00",  
    "location": "Ciudad de Mexico",  
    "observations": "WebHook Test",  
    "statusObj": {  
        "id": 2,  
        "code": "DLV",  
        "description": "ENTREGADO POD EN SISTEMA",  
        "description_en": "DELIVERED POD IN SYSTEM",  
        "long_description": "El mensajero logra concretar la entrega a la direcci?n impresa en la etiqueta del paquete y se obtiene evidencia (una fotograf?a y/o firma) para comprobar la entrega del paquete ",  
        "long_description_en": "The courier manages to make the delivery to the address printed on the package label and evidence is obtained (a photograph and / or signature) to verify the delivery of the package"  
    },  
    "POD": [-119,80,78,71,13,10,26,10,0,0,0,13,73,72,68,82,0,0,0,-108,0,0,0,-44,8,3,0,0,0,77,-70,-6,-118,0,0,0,1,115,82,71,66,0,-82,-50,28,-23,0,0,0,4,103,65,77,65,0,0,-79,-113,11,-4,97,5,0,0,0,111,80,76,84,69,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,109,-22,-67,70,0,0,0,36,116,82,78,83,0,5,7,15,24,25,30,37,38,44,48,50,52,72,74,77,78,83,99,102,105,108,110,113,-119,-105,-103,-79,-77,-63,-45,-31,-21,-20,-6,-4,105,57,-53,-48,0,0,0,9,112,72,89,115,0,0,50,-64,0,0,50,-64,1,40,100,90,-37,0,0,0,-97,73,68,65,84,120,94,-19,-50,89,78,-126,65,16,-123,-47,95,20,28,0,113,22,100,112,-86,-3,-81,-111,78,-68,123,-24,78,60,-25,-91,82,-33,-45,-99,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,-2,-81,-117,-36,97,44,15,-97,63,-11,125,122,-51,59,-124,-121,-118,93,-62,8,-114,-39,84,53,79,25,-64,111,38,85,-35,-89,-12,119,-107,69,-51,83,82,127,-41,89,-44,-68,39,-11,-73,-56,-94,-26,57,-87,-65,-53,44,106,30,-109,6,-16,-107,73,85,-85,-108,1,108,51,-87,-114,9,35,-104,125,-4,109,-38,-33,37,-116,-31,102,-3,-14,-74,-71,-51,3,0,0,0,0,0,0,0,0,0,0,0,0,93,77,-45,25,118,-20,15,60,-1,23,-87,-86,0,0,0,0,73,69,78,68,-82,66,96,-126],  
    "POD_B64": "iVBORw0KGgoAAAANSUhEUgAAAJQAAADUCAMAAABNuvqKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAABvUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAG3qvUYAAAAkdFJOUwAFBw8YGR4lJiwwMjRISk1OU2NmaWxucYmXmbGzwdPh6+z6/Gk5y9AAAAAJcEhZcwAAMsAAADLAAShkWtsAAACfSURBVHhe7c5ZToJBEIXRXxQcAHEWZHCq/a+RTrx76E4856VS39OdAAAAAAAAAAAAAAAAAAAAAP6vi9xhLA+fP/V9es07hIeKXcIIjtlUNU8ZwG8mVd2n9HeVRc1TUn/XWdS8J/W3yKLmOam/yyxqHpMG8JVJVauUAWwzqY4JI5h9/G3a3yWM4Wb98ra5zQMAAAAAAAAAAAAAAABdTdMZduwPPP8XqaoAAAAASUVORK5CYII=",  
    "POD_fileName": "file.png",  
    "dateTimeISO":"2024-04-03T14:57:00-06:00",  
    "value": "PRB0000000000001",  
    "date": "03/04/2024 14:57"  
}

👍

Image Example

The byteArray and B64 strings corresponds to the following image

🚧

To use the webhook and receive the update of the status of all the guides, you only have to share your end point and the key (if necessary) where you will receive the request explained above, do not forget to implement the response, to validate the receipt of the information.