Technical requirements

The Webhooks integration allows YOM to send automatic notifications to our customers' systems in real time. To implement this integration, you must meet the following technical requirements:

🌐 Webhook Receiving Endpoint

The customer must provide a URL that will act as the webhook receiving endpoint. This endpoint must be able to receive HTTP POST requests from YOM.

Receiving URL: <tu_dominio>/webhooks/yom
Usage example: POST <tu_dominio>/webhooks/yom

🔒 Authentication and Security toward YOM

To access YOM's endpoints, you must create a token based on a client_id and client_secret that will be provided to our customers.

The details of the endpoint used to generate the token are the following:

URL
- Staging
  - https://api.solopide.me/api/v2/auth/tokens/grant
- Production
  - https://api.youorder.me/api/v2/auth/tokens/grant
Method
- POST
Headers:
- Content-Type: application/json

Request Body:

Sent in JSON format. Example:

{
    "client_id": "nkguw0p01dafkQoRPTXO6",
    "client_secret": "IeC2SSfZEdFb8hASD#faskSADT83Y0tGN2CJmZWHY",
    "grant_type": "client_credentials"
}

Example response:

{
	"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NzJlMDUwYTBiMzFlY2UyYzhlMzkxOGYiLCJyb2xlcyI6WyJhZG1pbiJdLCJkb21haW4iOiJpMmJ0ZXN0LnNvbG9waWRlLm1lIiwiY3VzdG9tZXJJZCI6IjY3MmUwNTA3MGIzMWVjZTJjOGUzOTE3YiIsInBlcm1pc3Npb25zIjpbImNhdGVnb3J5OnJlYWQiLCJjYXRlZ29yeTpidWxrIiwiY29tbWVyY2U6d3JpdGUiLCJjdXN0b21lcjpyZWFkIiwiZGlzY291bnQtbGltaXRzOnJlYWQiLCJkaXNjb3VudC1saW1pdHM6d3JpdGUiLCJkaXNjb3VudC1saW1pdHM6YnVsayIsImRpc2NvdW50LWxpbWl0czpkZXN0cm95IiwiZG9tYWluOnJlYWQiLCJkb21haW46YnVsayIsImdyb3VwOnJlYWQiLCJncm91cDp3cml0ZSIsImdyb3VwOmRlc3Ryb3kiLCJncm91cDpidWxrIiwiaW1wb3J0OndyaXRlIiwiaW50ZWdyYXRpb24taW5mbzpyZWFkIiwiaW50ZWdyYXRpb24taW5mbzp3cml0ZSIsIm9yZGVyOnJTpyZWFkIiwib3ZlcnJpZGU6d3JpdGUiLCJvdmVycmlkZTpidWxrIiwicGF5bWVudDpyZWFkIiwicGVuZGluZy1kb2N1bWVudDpidWxrIiwicHJvbW90aW9uOnJlYWQiLCJwcm9tb3Rpb246d3JpdGUiLCJwcm9tb3Rpb246YnVsayIsInNhbGVzbWFuOnJlYWQiLCJzYWxlc21hbjp3cml0ZSIsInNhbGVzbWFuOmJ1bGsiLCJzZWdtZW50OnJlYWQiLCJzZWdtZW50OndyaXRlIiwic2VnbWVudDpidWxrIiwic2VnbWVudDpidWxrLWRlc3Ryb3kiLCJzZWxsZXI6cmVhZCIsInNlbGxlcjpidWxrIiwic2t1OnJlYWQiLCJza3U6YnVsayIsInN1cGVydmlzb3I6YnVsayIsInN0b3JlOnJlYWQiLCJzdWdnZXN0aW9uOnJlYWQiLCJzdWdnZXN0aW9uOmJ1bGsiLCJ1cGxvYWRlcjpyZWFkIiwidXBsb2FkZXI6d3JpdGUiXSwidmVyaWZpZWQiOnRydWUsImJsb2NrZWQiOmZhbHNlLCJ0eXBlIjoiYXBwbGljYXRpb24iLCJjb25uZWN0aW9uSWQiOiI2N2M3MWZhNmU1NzcyMmY2NGU3NjdiZDYiLCJpYXQiOjE3NDExMTI4NjksImV4cCI6MTc0MTExMzc2OX0.lTklbBucJ6o-CFAdSGeO5rfJM-VUmw_xEbQVdoIaUKE",
	"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NzJlMDUwYTBiMzFlY2UyYzhlMzkxOGYiLCJyb2xlcyI6WyJhZG1pbiJdLCJkb21haW4iOiJpMmJ0ZXN0LnNvbG9waWRlLm1lIiwiY3VzdG9tZXJJZCI6IjY3MmUwNTA3MGIzMWVjZTJjOGUzOTE3YiIsInBlcm1pc3Npb25zIjpbImNhdGVnb3J5OnJlYWQiLCJjYXRlZ29yeTpidWxrIiwiY29tbWVyY2U6d3JpdGUiLCJjdXN0b21lcjpyZWFkIiwiZGlzY291bnQtbGltaXRzOnJlYWQiLCJkaXNjb3VudC1saW1pdHM6d3JpdGUiLCJkaXNjb3VudC1saW1pdHM6YnVsayIsImRpc2NvdW50LWxpbWl0czpkZXN0cm95IiwiZG9tYWluOnJlYWQiLCJkb21haW46YnVsayIsImdyb3VwOnJlYWQiLCJncm91cDp3cml0ZSIsImdyb3VwOmRlc3Ryb3kiLCJncm91cDpidWxrIiwiaW1wb3J0OndyaXRlIiwiaW50ZWdyYXRpb24taW5mbzpyZWFkIiwiaW50ZWdyYXRpb24taW5mbzp3cml0ZSIsIm9yZGVyOnJTpyZWFkIiwib3ZlcnJpZGU6d3JpdGUiLCJvdmVycmlkZTpidWxrIiwicGF5bWVudDpyZWFkIiwicGVuZGluZy1kb2N1bWVudDpidWxrIiwicHJvbW90aW9uOnJlYWQiLCJwcm9tb3Rpb246d3JpdGUiLCJwcm9tb3Rpb246YnVsayIsInNhbGVzbWFuOnJlYWQiLCJzYWxlc21hbjp3cml0ZSIsInNhbGVzbWFuOmJ1bGsiLCJzZWdtZW50OnJlYWQiLCJzZWdtZW50OndyaXRlIiwic2VnbWVudDpidWxrIiwic2VnbWVudDpidWxrLWRlc3Ryb3kiLCJzZWxsZXI6cmVhZCIsInNlbGxlcjpidWxrIiwic2t1OnJlYWQiLCJza3U6YnVsayIsInN1cGVydmlzb3I6YnVsayIsInN0b3JlOnJlYWQiLCJzdWdnZXN0aW9uOnJlYWQiLCJzdWdnZXN0aW9uOmJ1bGsiLCJ1cGxvYWRlcjpyZWFkIiwidXBsb2FkZXI6d3JpdGUiXSwidmVyaWZpZWQiOnRydWUsImJsb2NrZWQiOmZhbHNlLCJ0eXBlIjoiYXBwbGljYXRpb24iLCJjb25uZWN0aW9uSWQiOiI2N2M3MWZhNmU1NzcyMmY2NGU3NjdiZDYiLCJpYXQiOjE3NDExMTI4NjksImV4cCI6MTc0MTExMzc2OX0.lTklbBucJ6o-CFAdSGeO5rfJM-VUmw_xEbQVdoIaUKE",
	"token_type": "bearer",
	"expires_in": 900
}

🔒 Customer API Authentication and Security

The endpoints must be protected by one of the following authentication mechanisms to ensure data security:

API Token 🔑

📋 Data Format

The Webhook requests sent by YOM are in JSON format. We recommend using UTF-8 for all responses.

Example payload: