List Integration Capabilities

GET

api

integrations

catalog

curl --request GET \
  --url https://api.sequenzy.com/api/v1/integrations/catalog \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/integrations/catalog', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/integrations/catalog",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/integrations/catalog"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/integrations/catalog")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "providers": [
    {
      "provider": "stripe",
      "name": "Stripe",
      "category": "payments",
      "availability": "available",
      "summary": "Syncs Stripe customers, subscriptions, and products, and turns billing webhooks into subscriber events, tags, and revenue attributes.",
      "connectMethod": "oauth",
      "syncs": ["customers", "subscriptions", "products", "revenue"],
      "emits": [
        {
          "event": "saas.purchase",
          "when": "a customer completes a purchase or starts a paid subscription"
        },
        {
          "event": "saas.payment_failed",
          "when": "a payment attempt fails (card declined, expired, insufficient funds)"
        }
      ],
      "writesAttributes": [
        {
          "key": "stripeCustomerId",
          "description": "The customer's stripe customer ID, copied on every sync."
        },
        {
          "key": "mrr",
          "description": "Monthly recurring revenue for the customer, as a number."
        }
      ],
      "actions": ["enable_sync", "disable_sync", "sync_now", "sync_products"],
      "notes": [
        "The only payment provider with full trial lifecycle coverage plus upgrade/downgrade detection."
      ]
    }
  ]
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Integration provider not found"
}

Describe what Sequenzy’s integration providers do, whether or not they are connected. Use this to decide what to connect, to compare providers, or to check that an event a sequence needs actually exists for a given provider. Coverage differs sharply between providers. Only Shopify has storefront browse tracking, and only Stripe and Chargebee cover the full trial lifecycle - so check here rather than assuming a provider emits an event.

Request

string

Return only this provider, such as stripe or shopify. Returns 404 for an unknown provider.

string

Filter by category: payments, ecommerce, auth, analytics, ads, affiliate, cms, or developer.

curl "https://api.sequenzy.com/api/v1/integrations/catalog?provider=stripe" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response fields

string

available, beta, or coming_soon. A coming_soon provider appears in the dashboard picker but has no webhook handler yet, so it emits nothing.

string

How the provider is connected: oauth, api_key, app_install, plugin, or webhook. OAuth and app installs always need a person in the dashboard.

string[]

What the integration keeps in sync, such as customers, orders, or products. Empty when the provider only pushes events as they happen.

object[]

Every event the provider can produce. Each entry has event (the name a sequence triggers on) and when (the real-world moment that produces it). An empty array means the provider never triggers automations.

object[]

Subscriber attributes the provider writes, each with a key and description. Use these in segment filters.

string[]

Actions supported on a connected integration: enable_sync, disable_sync, sync_now, or sync_products.

string[]

Caveats worth knowing before building on the provider, such as which events it does not emit.

Responses

{
  "success": true,
  "providers": [
    {
      "provider": "stripe",
      "name": "Stripe",
      "category": "payments",
      "availability": "available",
      "summary": "Syncs Stripe customers, subscriptions, and products, and turns billing webhooks into subscriber events, tags, and revenue attributes.",
      "connectMethod": "oauth",
      "syncs": ["customers", "subscriptions", "products", "revenue"],
      "emits": [
        {
          "event": "saas.purchase",
          "when": "a customer completes a purchase or starts a paid subscription"
        },
        {
          "event": "saas.payment_failed",
          "when": "a payment attempt fails (card declined, expired, insufficient funds)"
        }
      ],
      "writesAttributes": [
        {
          "key": "stripeCustomerId",
          "description": "The customer's stripe customer ID, copied on every sync."
        },
        {
          "key": "mrr",
          "description": "Monthly recurring revenue for the customer, as a number."
        }
      ],
      "actions": ["enable_sync", "disable_sync", "sync_now", "sync_products"],
      "notes": [
        "The only payment provider with full trial lifecycle coverage plus upgrade/downgrade detection."
      ]
    }
  ]
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Integration provider not found"
}

List Integration ActivityRead recent integration webhook and sync activity

List Integration Capabilities

curl --request GET \
  --url https://api.sequenzy.com/api/v1/integrations/catalog \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/integrations/catalog', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/integrations/catalog",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/integrations/catalog"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/integrations/catalog")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "providers": [
    {
      "provider": "stripe",
      "name": "Stripe",
      "category": "payments",
      "availability": "available",
      "summary": "Syncs Stripe customers, subscriptions, and products, and turns billing webhooks into subscriber events, tags, and revenue attributes.",
      "connectMethod": "oauth",
      "syncs": ["customers", "subscriptions", "products", "revenue"],
      "emits": [
        {
          "event": "saas.purchase",
          "when": "a customer completes a purchase or starts a paid subscription"
        },
        {
          "event": "saas.payment_failed",
          "when": "a payment attempt fails (card declined, expired, insufficient funds)"
        }
      ],
      "writesAttributes": [
        {
          "key": "stripeCustomerId",
          "description": "The customer's stripe customer ID, copied on every sync."
        },
        {
          "key": "mrr",
          "description": "Monthly recurring revenue for the customer, as a number."
        }
      ],
      "actions": ["enable_sync", "disable_sync", "sync_now", "sync_products"],
      "notes": [
        "The only payment provider with full trial lifecycle coverage plus upgrade/downgrade detection."
      ]
    }
  ]
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Integration provider not found"
}

Overview

Companies

Sync Rules

Shopify

Websites

Integrations

Sender Profiles

Tracking Settings

Notification Preferences

Subscribers

Tags

Lists

Events

Segments

Audience Syncs

Migrations

Products

Media

Analytics

Sequences

Generation

SMS

Campaigns

Landing Pages

Emails

A/B Tests

Email Sends

Suppressions

Transactional

Templates

Widgets

Commerce

Webhooks

Team

Conversations

List Integration Capabilities

Request

Response fields

Responses

​Request

​Response fields

​Responses

Request

Response fields

Responses