API Reference
Start typing to search…

Admission Automatic Routing Process Created event

This event is triggered when the pre-employee search for transportation route options while filling out the automatic routing transportation benefit.

Notification properties

The notification will be sent with the following properties:

Property

Type

Description

routingId

string

Identifier of the new routing, provided by Gupy in uuid format.

companyId

number

Company ID.

preEmployeeName

string

Pre employee name.

identification

string

Pre employee CPF document (only numbers).

e.g., 12345678910.

companyAddress

string

Full address of the company/branch.

e.g., Avenida Paulista, 1079, Bela Vista, 01311200, São Paulo - SP, Brasil.

Must overwrite the company's registered address in the partner system.

companyAddressZipCode

string | null

Zip code of the company/branch, which will be the destination of the routing.

e.g., 12345678.

Must overwrite the company's registered address in the partner system.

companyAddressStreet

string | null

Company/branch address street.

Must overwrite the company's registered address in the partner system.

companyAddressNumber

string | null

Company/branch address number.

Must overwrite the company's registered address in the partner system.

companyAddressNeighborhood

string | null

Company/branch address neighborhood.

Must overwrite the company's registered address in the partner system.

companyAddressCity

string | null

Company/branch address city.

Must overwrite the company's registered address in the partner system.

companyAddressState

string | null

Company/branch address status.

e.g., SP.

Must overwrite the company's registered address in the partner system.

preEmployeeAddressZipCode

string

Zip code of the pre employee

e.g., 12345678.

preEmployeeAddressStreet

string

Street address of the pre employee.

preEmployeeAddressNumber

string

Address number of the pre employee.

e.g., 123 or 2-A.

preEmployeeAddressNeighborhood

string

Neighborhood of the pre employee's address.

preEmployeeAddressCity

string

City of address of the pre employee.

preEmployeeAddressState

string

State of address of the pre employee.

e.g., SP.

startOfWorkday

string

Start of the pre employee's workday.

e.g., 09:00.

endOfWorkday

string

End of the pre employee's working day.

e.g., 18:00.

daysOfWork

number

Number of days worked in the month by the pre employee.

e.g., 22.

Example

{
  "companyName": "ACME",
  "id": "24e99765-8583-4be5-87ae-489c86642964", 
  "event": "admission.automatic-routing-process",  
  "date": "2019-06-19T23:48:46.952Z", 
  "data": {
    "routingId": "e3dd4f68-929b-49b4-8a9d-42c2b952c3e8",
    "companyId": 1,
    "companyAddress": "Avenida Paulista, 1079 - Bela Vista, São Paulo - SP, 01311-200", 
    "companyAddressZipCode": "01311200", 
    "companyAddressStreet": "Avenida Paulista", 
    "companyAddressNumber": "1079", 
    "companyAddressNeighborhood": "Bela Vista", 
    "companyAddressCity": "São Paulo", 
    "companyAddressState": "SP", 
    "preEmployeeName": "John Doe", 
    "identification": "12345678909", 
    "preEmployeeAddressZipCode": "00000000", 
    "preEmployeeAddressStreet": "Avenida Paulista", 
    "preEmployeeAddressNumber": "123", 
    "preEmployeeAddressNeighborhood": "Jardins", 
    "preEmployeeAddressCity": "São Paulo", 
    "preEmployeeAddressState": "SP", 
    "startOfWorkday": "09:00", 
    "endOfWorkday": "18:00", 
    "daysOfWork": "20"
  }
}

Considerations

Idempotency of companyId

The value of this property may or may not change depending on the integration flow's current stage;

  • When it remains the same: In the retry attempt to request a new route, in a divergence flow.
  • When it changes:
    • When the pre-employee's or company's address is changed relative to the last route request made;
    • When the pre-employee's or company's address is changed in the middle of an existing objection process;

Possibility of addresses under the company prefix

These addresses aren't fixed, as companies can change them (due to technical or business requirements).

This means that in a routing request A, a specific address might be sent, and in a subsequent routing request B, a different address could be sent, both being idempotent.

🚧

Bad Practice Alert

Don't correlate the companyId property with an internal Company entity that stores the address received via this event notification.