Overview

The webhook uses heartbeats to indicate presence. Servers send periodic heartbeats, which identify a merchant's presence.When enabling the webhook, presence requests start in the next heartbeat cycle (up to 30 seconds). There are two types of heartbeat: per application and per merchant, for detailed presence control.

Requests per application

For integrations that don't have fine-grained presence control, we have the configuration to perform a single periodic heartbeat request for the application, making all merchants of the application go online.In this case, requests with 202 Accepted response cause the heartbeat message to be generated, and any other response prevents the heartbeat from being generated. The response body will be ignored.

In practice, this means that all merchants with order scope from the integration will be open in the listing, as long as they meet the other criteria.

Request body example

{
    "code":"KEEPALIVE",
    "fullCode":"KEEPALIVE",
    "id":"a38ba215-f949-4b2c-982a-0582a9d0c10e"
}

Request example

Check the formatting impact on signature.

curl --location 'http://localhost:8080/webhook' \
--header 'X-IFood-Signature: 6c0a429606266905349388ebc1eb12b8b98524dddd6b4bdc41c4b67591075b4c' \
--header 'Content-Type: application/json' \
--data '{
    "code":"KEEPALIVE",
    "fullCode":"KEEPALIVE",
    "id":"a38ba215-f949-4b2c-982a-0582a9d0c10e"
}'

We send only relevant information for the integration and maintain compatibility with order events.

Requests per merchant

When the integration uses fine-grained presence control, the system sends heartbeat requests for groups of merchants. Each request can include up to 1000 merchants.The response must have 202 Accepted status and list the online merchants in the response body. The system generates heartbeats only for those merchants.

Request body example

{
    "code":"KEEPALIVE",
    "fullCode":"KEEPALIVE",
    "id":"a38ba215-f949-4b2c-982a-0582a9d0c10e",
    "merchantIds": ["cad65e8f-6fc6-438a-b159-e64a902a6b9a", "438a5e8f-6fc6-438a-b159-e64a902a6879"]
}

Response: only the "online" merchants

{
   "merchantIds": ["cad65e8f-6fc6-438a-b159-e64a902a6b9a"]
}

Request example

Check the formatting impact on signature.

curl --location 'http://localhost:8080/webhook' \
--header 'X-IFood-Signature: dc900bca38c8b6f908ea688a24604fa581921d1211da4211e4f5e139732c2ff1' \
--header 'Content-Type: application/json' \
--data '{
    "code":"KEEPALIVE",
    "fullCode":"KEEPALIVE",
    "id":"a38ba215-f949-4b2c-982a-0582a9d0c10e",
    "merchantIds": ["cad65e8f-6fc6-438a-b159-e64a902a6b9a", "438a5e8f-6fc6-438a-b159-e64a902a6879"]
}'

We send only relevant information for the integration and maintain compatibility with order events.

Was this page helpful?

Rate your experience in the new Developer portal:

On this page

Overview

Requests per application

Requests per merchant

Content read0%