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

Pixel

Operations

Create pixel

Request

This route allows you to create a tracking pixel linked to your account, with support for Google and Meta platforms. After creation, the pixel must be integrated into your website or application using our official SDK to ensure proper event sending and tracking.

👉 Access the SDK and usage instructions: SDK

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/json
namestringrequired
descriptionstring
ownerIdstringrequired
externalReferenceIdstringrequired
platformstringrequired

available platforms: google, meta, gtm and tiktok

codestring
eventsArray of stringsrequired

An array of event types that the pixel should track. Each item must be one of the predefined event identifiers listed below:

  • checkout-initialized

  • purchase-completed

  • purchase-failed

  • purchase-btn-clicked

  • pix-selected

  • pix-generated

  • pix-expired

  • pix-copied

  • credit-card-form-init

  • credit-card-selected

  • credit-card-form-completed

  • bank-slip-selected

  • bank-slip-form-completed

  • address-form-completed

  • delivery-address-completed

  • coupon-added

  • coupon-box-clicked

  • coupon-form-init

  • coupon-form-completed

  • coupon-apply-failed

  • user-form-init

  • user-form-completed

  • pre-checkout-form-init

  • pre-checkout-form-completed

metadataobject
serverSideMetadataobject
curl -i -X POST \
  https://docs.easyflow.digital/_mock/openapi/pixels \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "name": "string",
    "description": "string",
    "ownerId": "string",
    "externalReferenceId": "string",
    "platform": "string",
    "code": "string",
    "events": [
      "string"
    ],
    "metadata": {
      "conversion-label": "string"
    },
    "serverSideMetadata": {
      "capi-access-token": "string",
      "enable-capi-access-token": "string"
    }
  }'

Responses

pixel creation was successful

Bodyapplication/json
statusCodeinteger
dataobject
Response
application/json
{
  "statusCode": 0,
  "data": {
    "pixel": { … }
  }
}

Update pixel

Request

Route to update pixel.

Path
pixelIdstringrequired
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/json
namestring
descriptionstring
statusstring

permitted status: active and inactive

platformstring

available platforms: google, meta, gtm and tiktok

codestring
eventsArray of strings

An array of event types that the pixel should track. Each item must be one of the predefined event identifiers listed below:

  • checkout-initialized

  • purchase-completed

  • purchase-failed

  • purchase-btn-clicked

  • pix-selected

  • pix-generated

  • pix-expired

  • pix-copied

  • credit-card-form-init

  • credit-card-selected

  • credit-card-form-completed

  • bank-slip-selected

  • bank-slip-form-completed

  • address-form-completed

  • delivery-address-completed

  • coupon-added

  • coupon-box-clicked

  • coupon-form-init

  • coupon-form-completed

  • coupon-apply-failed

  • user-form-init

  • user-form-completed

  • pre-checkout-form-init

  • pre-checkout-form-completed

serverSideMetadataobject
curl -i -X PATCH \
  'https://docs.easyflow.digital/_mock/openapi/pixels/{pixelId}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "name": "string",
    "description": "string",
    "status": "string",
    "platform": "string",
    "code": "string",
    "events": [
      "string"
    ],
    "serverSideMetadata": {
      "capi-access-token": "string",
      "enable-capi-access-token": "string"
    }
  }'

Responses

returns true if you managed to update the pixel.

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

List pixels

Request

Returns a list of pixels.

Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

filter[ownerId]stringrequired
filter[externalReferenceId]string
filter[code]string
filter[platform]string
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/pixels/list?page=string&limit=string&filter%5BownerId%5D=string&filter%5BexternalReferenceId%5D=string&filter%5Bcode%5D=string&filter%5Bplatform%5D=string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Returns a list of pixels.

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

Events

Webhooks