Skip to content

Easyflow (1.0)

Easyflow API Document

This is the API documentation and must be used by everyone who wants to integrate with the Easyflow platform.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Languages
Servers
Mock server
https://docs.easyflow.digital/_mock/openapi/
Production environment URL
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/

Businesses

Operations

Refunds

Operations

Sales

Operations

Subscriptions

Operations

Financials

Operations

Products

Operations

Orders

Operations

Customers

Operations

Webhooks

Operations

Create webhook

Request

Registers a new webhook for event notifications.

Headers
x-api-keystringrequired

Api key provided on integrations tab in Easyflow platform.

x-api-secretstringrequired

Api Secret provided on integrations tab in Easyflow platform.

Bodyapplication/jsonrequired

Webhook configuration body

externalAccountIdstring(uuid)
dispatchersArray of objects
eventsArray of strings

List of events to subscribe to.

Items Enum"order.chargeback""order.updated""order.canceled""order.created""order.paid""order.partiallyPaid""order.refunded""subscription.created""subscription.updated""subscription.activated"
namestring
notifyOnFailobject
curl -i -X POST \
  https://docs.easyflow.digital/_mock/openapi/webhooks \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "externalAccountId": "11111111-2222-3333-4444-555555555555",
    "dispatchers": [
      {
        "type": "http",
        "headers": {
          "X-fingerprint-id": "928371",
          "Authorization": "Bearer mocktoken123"
        },
        "method": "POST",
        "url": "https://webhook.site/mock-url-123"
      }
    ],
    "events": [
      "order.paid",
      "order.created",
      "subscription.updated"
    ],
    "name": "CRM Integration",
    "notifyOnFail": {
      "email": "integration@mock.com",
      "name": "Webhook Admin"
    }
  }'

Responses

Webhook successfully created.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "id": "692f3483106ee1344d9aa243",
    "account": "6797d9adf58e3a33526c53e1",
    "queue": "692f3483106ee1344d9aa23f",
    "name": "Integration",
    "status": "active",
    "events": [ … ],
    "dispatchers": [ … ],
    "notifyOnFail": { … },
    "createdAt": "2025-12-02T18:48:35.112Z",
    "updatedAt": "2025-12-02T18:48:35.112Z"
  }
}

List webhooks

Request

Returns a paginated list of registered webhooks for a given business, filtered by status, events and date range.

Path
businessIdstring(uuid)required
Query
limitstringrequired

Number of items to be loaded per page

pagestringrequired

Page number to access

statusstring

Filter by webhook status.

Enum"active""inactive""unavailable"
initialDatestring(date-time)

Start date for filtering (ISO 8601).

endDatestring(date-time)

End date for filtering (ISO 8601).

eventsstring

Filter by webhook events (multiple events allowed).

Enum"order.chargeback""order.updated""order.canceled""order.created""order.paid""order.partiallyPaid""order.refunded""subscription.created""subscription.updated""subscription.activated"
Headers
x-api-keystringrequired

Api key provided on integrations tab in Easyflow platform.

x-api-secretstringrequired

Api Secret provided on integrations tab in Easyflow platform.

curl -i -X GET \
  'https://docs.easyflow.digital/_mock/openapi/webhooks/list/{businessId}?limit=string&page=string&status=active&initialDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&events=order.chargeback' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Successfully returned webhook list.

Bodyapplication/json
statusCodeinteger
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "docs": [ … ],
    "totalDocs": 1,
    "totalPages": 1,
    "currentPage": 1,
    "limit": 50
  }
}

Get webhook queue details

Request

Retrieves the details of the dedicated dynamic queue associated with a specific webhook ID. This queue is used to temporarily store failed event notifications for subsequent retry attempts, ensuring delivery resilience.

Path
webhookIdstringrequired

The unique identifier of the webhook whose queue details are to be retrieved.

Example: 692f3483106ee1344d9aa243
Headers
x-api-keystringrequired

Api key provided on integrations tab in Easyflow platform.

x-api-secretstringrequired

Api Secret provided on integrations tab in Easyflow platform.

curl -i -X GET \
  https://docs.easyflow.digital/_mock/openapi/webhooks/dynamic-queues/692f3483106ee1344d9aa243 \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Successfully returned the webhook queue details.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "id": "692f3483106ee1344d9aa23f",
    "name": "easy_internal_wb_af965c2a-5075-4d72-993d-aeac1a7b4aa6_queue",
    "status": "active",
    "createdAt": "2025-12-02T18:48:35.097Z",
    "updatedAt": "2025-12-02T18:48:35.097Z",
    "messagesAvailable": 0
  }
}

Pixel

Operations

Events

Webhooks