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

Get webhook

Request

Retrieves the complete configuration and current status details for a single webhook identified by its unique ID.

Path
webhookIdstringrequired

The unique identifier of the webhook to retrieve.

Example: 68d5622fa0742e0289f2284a
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/details/68d5622fa0742e0289f2284a \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Successfully returned the webhook details.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "id": "68d5622fa0742e0289f2284a",
    "account": { … },
    "queue": { … },
    "name": "test",
    "status": "inactive",
    "events": [ … ],
    "dispatchers": [ … ],
    "notifyOnFail": { … },
    "createdAt": "2025-09-25T15:39:27.114Z",
    "updatedAt": "2025-10-21T14:17:24.969Z"
  }
}

Flush webhook pending queue

Request

Clears all pending event notifications currently queued for a specific webhook. This action discards all failed attempts that are waiting for re-execution.

Path
webhookIdstringrequired

The unique identifier of the webhook whose queue will be flushed.

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 PATCH \
  https://docs.easyflow.digital/_mock/openapi/webhooks/flush/692f3483106ee1344d9aa243 \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Webhook queue successfully flushed.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "flushed": true
  }
}

Resume webhook pending queue processing

Request

Triggers the re-execution process for all pending event notifications currently queued for a specific webhook, attempting delivery again.

Path
webhookIdstringrequired

The unique identifier of the webhook whose queue processing will be resumed.

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 PATCH \
  https://docs.easyflow.digital/_mock/openapi/webhooks/resume/692f3483106ee1344d9aa243 \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Webhook queue processing successfully resumed.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "resumed": true
  }
}

Pixel

Operations

Events

Webhooks