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

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
  }
}

Update webhook configuration

Request

Updates the configuration details of an existing webhook, including subscribed events, name, notification failure settings, and HTTP dispatcher configuration.

Path
webhookIdstringrequired

The unique identifier of the webhook to be updated.

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.

Bodyapplication/jsonrequired

Webhook configuration fields to update. Note that only provided fields will be modified (partial update).

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

The new name for the webhook.

notifyOnFailobject

Configuration for receiving notifications upon webhook delivery failures.

httpDispatcherobject

Updates to the HTTP dispatcher configuration.

curl -i -X PATCH \
  https://docs.easyflow.digital/_mock/openapi/webhooks/692f3483106ee1344d9aa243 \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "events": [
      "order.paid",
      "subscription.updated"
    ],
    "name": "Integração Atualizada",
    "notifyOnFail": {
      "email": "jon@gmail.com",
      "name": "Jon Santos"
    },
    "httpDispatcher": {
      "id": "692f3483106ee1344d9aa23d",
      "headers": {
        "X-fingerprint-id": "321023"
      },
      "method": "POST",
      "url": "https://webhook.site/9c8b39c9-8658-4e9a-b9d1-89c9f41e1e4a"
    }
  }'

Responses

Webhook successfully updated.

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

Pixel

Operations

Events

Webhooks