Get Notification

Use this endpoint to get the details of a specific notification by its id.

Available Environments

Production

https://api.gateway.com.br/dispatcher

Endpoint

• Method: GET
• Endpoint: /request/{id}
• Authentication: Bearer token

Path Params

Name	Type	Required	Description	Validations
id	string	Yes	Notification identifier	Must be a valid notification ID

Request Example

cURL

curl --request GET \
--url https://api.gateway.com.br/dispatcher/request/553e8400-e29b-41d4-a716-446655440000 \
--header 'Authorization: Bearer your-jwt-token'

JavaScript

const response = await fetch('https://api.gateway.com.br/dispatcher/request/553e8400-e29b-41d4-a716-446655440000', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const data = await response.json();

Success Response

Field	Type	Required	Description
id	string	Yes	Notification ID
hash	string	Yes	Notification hash
tenant	string	Yes	Tenant of the notification
url	string	Yes	Destination URL of the notification
referenceId	string	Yes	Reference ID
body	object | string	Yes	Payload sent in the notification
tags	string[]	Yes	Notification tags
status	string (enum) - RECEIVED, SENT, FAILED, ERROR	Yes	Current status of the notification
statusHistory	array	Yes	Status history (see Sub-Object StatusHistory)
createdAt	string (ISO)	Yes	Creation date
updatedAt	string (ISO)	Yes	Last update date
executions	array	Yes	Notification executions (see Sub-Object Execution)
error	string	Yes	Error message of the notification (returns null when there is no error)

Sub-Objects

StatusHistory (item)

Field	Type	Required	Description
status	string	Yes	Status recorded in the history
date	string (ISO)	Yes	Date and time of the status change
durationInMilliseconds	number	No	Duration of the previous status in milliseconds

Execution (item)

Field	Type	Required	Description
url	string	Yes	URL called on the notification execution
headers	object	No	Headers sent on the execution
createdAt	string (ISO)	Yes	Date and time of the execution
response	object	Yes	Execution response (see Sub-Object ResponseVo)
userId	string	Yes	Identifier of the user related to the execution
storeId	string	Yes	Identifier of the store related to the execution

ResponseVo

Field	Type	Required	Description
statusCode	number	Yes	HTTP status code returned by the destination
body	any	Yes	Response body returned by the destination
responseTime	number	Yes	Execution response time in milliseconds

Response Example (with every field)

{
  "id": "553e8400-e29b-41d4-a716-446655440000",
  "hash": "ffb2f88d-a863-4a03-bf53-81e7ef73db31",
  "tenant": "splitwave.com.br",
  "url": "https://api.example.com/webhook",
  "referenceId": "123e4567-e89b-12d3-a456-426614174001",
  "body": {
    "event": "PAYMENT_APPROVED",
    "amount": 1000
  },
  "tags": ["webhook", "notification"],
  "status": "RECEIVED",
  "statusHistory": [
    {
      "status": "RECEIVED",
      "date": "2026-03-24T10:00:00.000Z",
      "durationInMilliseconds": 1000
    },
    {
      "status": "FAILED",
      "date": "2026-03-24T10:00:01.000Z",
      "durationInMilliseconds": 4000
    },
    {
      "status": "SENT",
      "date": "2026-03-24T10:00:05.000Z"
    }
  ],
  "createdAt": "2026-03-24T10:00:00.000Z",
  "updatedAt": "2026-03-24T10:00:05.000Z",
  "executions": [
    {
      "url": "https://api.example.com/webhooks/order-events",
      "headers": {
        "Content-Type": "application/json",
        "X-Splitwave-Signature": "sha256=abcdef123456"
      },
      "createdAt": "2026-03-24T10:00:01.000Z",
      "response": {
        "statusCode": 500,
        "body": "Internal Server Error",
        "responseTime": 1200
      },
      "userId": "11111111-1111-1111-1111-111111111111",
      "storeId": "22222222-2222-2222-2222-222222222222"
    },
    {
      "url": "https://api.example.com/webhooks/order-events",
      "headers": {
        "Content-Type": "application/json",
        "X-Splitwave-Signature": "sha256=abcdef123456"
      },
      "createdAt": "2026-03-24T10:00:05.000Z",
      "response": {
        "statusCode": 200,
        "body": "ok",
        "responseTime": 350
      },
      "userId": "11111111-1111-1111-1111-111111111111",
      "storeId": "22222222-2222-2222-2222-222222222222"
    }
  ],
  "error": "Connection timeout on first attempt"
}

Possible Errors

Code	Description	Solution
401	Invalid credentials	Check your token
403	No permission/authorization	Check the get_dispatcher scope
404	Notification not found	Check the id you sent
500	Internal error	Contact support