List Notifications

Use this endpoint to list webhook notifications with filters.

Available Environments

Production

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

Endpoint

• Method: GET
• Endpoint: /request
• Authentication: Bearer token

Query Params

ℹ️ Dates in ISO

The startDate and endDate fields must be sent as an ISO date string with time.

Example:

• 2026-03-24T12:00:00.000Z

ℹ️ Arrays in the query string

The status and tags fields accept multiple values.

Example:

• status=SENT&status=FAILED
• tags=PAID&tags=CANCELLED

Name	Type	Required	Description	Validations
startDate	string	No	Start date of the filter	Must be an ISO date string with time
endDate	string	No	End date of the filter	Must be an ISO date string with time
referenceId	string	No	Reference ID of the notification	Cannot be empty
status	string[] (enum) - RECEIVED, SENT, FAILED, ERROR	No	List of statuses to filter by	Must be a non-empty array
tags	string[]	No	List of tags to filter by	Must be a non-empty array of strings

Request Example (with every field)

cURL

curl --request GET \
--url "https://api.gateway.com.br/dispatcher/request?startDate=2026-03-01T00:00:00.000Z&endDate=2026-03-24T23:59:59.999Z&referenceId=6d66e879-0345-44c9-9146-3cfc81842684&status=RECEIVED&status=SENT&status=FAILED&status=ERROR&tags=PAID&tags=CANCELLED" \
--header 'Authorization: Bearer your-jwt-token'

JavaScript

const params = new URLSearchParams({
  startDate: '2026-03-01T00:00:00.000Z',
  endDate: '2026-03-24T23:59:59.999Z',
  referenceId: '6d66e879-0345-44c9-9146-3cfc81842684'
});

params.append('status', 'RECEIVED');
params.append('status', 'SENT');
params.append('status', 'FAILED');
params.append('status', 'ERROR');
params.append('tags', 'PAID');
params.append('tags', 'CANCELLED');

const response = await fetch(`https://api.gateway.com.br/dispatcher/request?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});

const data = await response.json();

Success Response

Field	Type	Required	Description
total	number	Yes	Total items
totalPages	number	Yes	Total pages
currentPage	number	Yes	Current page
perPage	number	Yes	Items per page
data	array	Yes	List of notifications

Fields of the item in data

Field	Type	Required	Description
id	string (UUID)	Yes	Notification identifier
referenceId	string	Yes	Reference ID of the notification
url	string	Yes	Destination URL of the notification
status	string (enum) - RECEIVED, SENT, FAILED, ERROR	Yes	Notification status
tags	string[]	Yes	Tags attached to the notification
createdAt	string (ISO)	Yes	Creation date
userId	string (UUID)	Yes	Identifier of the responsible user
storeId	string (UUID)	Yes	Store identifier

Response Example

{
  "total": 2,
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 10,
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-446655440000",
      "referenceId": "6d66e879-0345-44c9-9146-3cfc81842684",
      "url": "https://api.example.com/webhooks/order-events",
      "status": "SENT",
      "tags": ["PAID", "CANCELLED"],
      "createdAt": "2026-03-24T10:00:00.000Z",
      "userId": "11111111-1111-1111-1111-111111111111",
      "storeId": "22222222-2222-2222-2222-222222222222"
    },
    {
      "id": "663e8400-e29b-41d4-a716-446655440001",
      "referenceId": "4ef9706d-5ea3-4f07-b282-c6be9ac83c9b",
      "url": "https://api.example.com/webhooks/billing-events",
      "status": "FAILED",
      "tags": ["CANCELLED", "webhook"],
      "createdAt": "2026-03-24T11:00:00.000Z",
      "userId": "33333333-3333-3333-3333-333333333333",
      "storeId": "44444444-4444-4444-4444-444444444444"
    }
  ]
}

Possible Errors

Code	Description	Solution
401	Invalid credentials	Check your token
403	No permission/authorization	Check the user scope
404	No notification found	Adjust the query filters
422	Invalid or missing data	Check the format of the parameters
500	Internal error	Contact support