This outbound webhook request notifies recipients about changes in trip status.
Use of this webhook requires the integrator to provide an endpoint. Webhook events are published to client-provided endpoints.
The supported status values are: ACCEPTED, CANCELLED, or COMPLETED.
This event is required for checkin and occurs on checkinStatus updates to one of the following: ACCEPTED, COMPLETED, or CANCELLED. It also occurs on checkinTripStatus updates to one of the following: ON_THE_WAY or ARRIVED.
ON_THE_WAY and ARRIVED are better specified using START_TRIP and TRIP_ARRIVED event types.
Event Name, Webhook Event Type, and Trigger
The event names, webhook event types, and triggers listed below reference how Checkin Notification Engine (CINE) generates events when clients use Checkin as a Service (ChaaS) APIs. If the client application does not use Checkin as a Service (ChaaS), then the client must generate the following events and publish those events to Store Assist.
| Event Name | Webhook Event Type | Trigger |
|---|---|---|
| Checkin Accepted | FAAS_ORDER_CHECKIN_STATUS | When the associate endpoint calls the Update Checkin request with an ACCEPTED status, this notification is sent to all associates. |
| Customer Served | FAAS_ORDER_CHECKIN_STATUS | When the associate endpoint calls the Update Checkin request with the COMPLETED status, this notification is sent to all associates. |
| Checkin Canceled | FAAS_ORDER_CHECKIN_STATUS | When the associate endpoint calls the Update Checkin request with the CANCELLED status, this notification is sent to all associates. |