API Reference

Management API

The Synqly Management APIs enable you to manage the resources within your Synqly organization, such as setting up Accounts for your customers and creating Integrations to connect your product to the different service Providers supported by Synqly.

For more information see the Synqly Overview.

Download OpenAPI description

management.json

management.yaml

Servers

Synqly

https://api.synqly.com/

Accounts

Accounts under your Organization are used to manage Integrations, Credentials, and other account specific resources. Accounts are secure containers and may be used to represent tenants in your system. Data is never shared across accounts.

For more information on Accounts, see the Synqly Overview.

Operations

Audit

Operations

Auth

Operations

Bridges

Operations

Capabilities

Operations

Credentials

Operations

Integration Points

An Integration Point describes a class of Integrations, and lets you describe names, allowed providers and other configuration that should apply to integrations associated with the Integration Point.

While an Integration can be created without associating it with an Integration Point, some Synqly features require the use of Integration Points, such as:

Connect UI
Validating allowed providers
Custom data mapping (coming soon)

Integration Points belong to the Organization, and can be associated with Integrations belonging to different Accounts.

For more information on Integration Points, see the Synqly Overview.

Operations

Integrations

An Integration represents the connection to a specific Provider. Once configured, an Integration enables interaction with the target Provider via our unified and normalized Connector APIs.

Each Integration belongs to an Account and may be associated with an Integration Point to provide additional features and configuration.

For more information on Integrations, see the Synqly Overview.

Operations

Members

Operations

Operations (In Development)

In Development

This feature is actively being developed. Breaking changes should be expected.

Please contact us before using this feature.

Operations

Organization Webhooks

Operations

List Organization Webhooks

Request

List webhooks for the organization

Query

limitinteger or null

Number of Webhook objects to return in this page. Defaults to 100.

start_afterstring or null

Return Webhook objects starting after this name.

orderArray of strings or null

Select a field to order the results by. Defaults to name. To control the direction of the sorting, append [asc] or [desc] to the field name. For example, name[desc] will sort the results by name in descending order. The ordering defaults to asc if not specified. May be used multiple times to order by multiple fields, and the ordering is applied in the order the fields are specified.

filterArray of strings or null

Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together.

curl -i -X GET \
  'https://api.synqly.com/v1/organization/webhooks?filter=string&limit=0&order=string&start_after=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultArray of objects(OrganizationWebhook)required

List of webhooks for the organization.

result[].idstring(Id)required

result[].fullnamestringrequired

Human friendly slug for this webhook

result[].environmentstring(Environment)required

Enum"test""prod"

result[].filtersArray of strings(WebhookFilter)required

Specifies which Webhooks to send.

Items Enum"all""account_create""account_delete""account_update""integration_create""integration_delete""integration_update""operation_complete"

result[].urlstringrequired

URL that webhooks will be sent to

result[].credential_idstring(Id)required

result[].namestringrequired

Human-readable name for this resource

result[].created_atstring(date-time)required

Time object was originally created

result[].updated_atstring(date-time)required

Last time object was updated

Response

application/json

{
  "result": [
    { … }
  ]
}

Create Organization Webhook

Request

Create a new webhook for the organization

Bodyapplication/jsonrequired

filtersArray of strings(WebhookFilter)required

Specifies which Webhooks to send.

Items Enum"all""account_create""account_delete""account_update""integration_create""integration_delete""integration_update""operation_complete"

urlstringrequired

URL that webhooks will be sent to.

secretobject(OrganizationWebhookSecret)required

secret.valuestringrequired

Secret used for signing webhooks. This value is used to verify the authenticity of the webhook payload.

secret.expiresstring or null(date-time)

Time when this secret expires and can no longer be used again.

namestring or null

Human friendly slug for this webhook

fullnamestring or null

Fullname for this webhook

environmentstring(Environment)

Enum"test""prod"

curl -i -X POST \
  https://api.synqly.com/v1/organization/webhooks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "fullname": "string",
    "environment": "test",
    "filters": [
      "all"
    ],
    "url": "string",
    "secret": {
      "value": "string",
      "expires": "2019-08-24T14:15:22Z"
    }
  }'

Responses

Bodyapplication/json

resultobject(OrganizationWebhook)required

result.idstring(Id)required

result.fullnamestringrequired

Human friendly slug for this webhook

result.environmentstring(Environment)required

Enum"test""prod"

result.filtersArray of strings(WebhookFilter)required

Specifies which Webhooks to send.

Items Enum"all""account_create""account_delete""account_update""integration_create""integration_delete""integration_update""operation_complete"

result.urlstringrequired

URL that webhooks will be sent to

result.credential_idstring(Id)required

result.namestringrequired

Human-readable name for this resource

result.created_atstring(date-time)required

Time object was originally created

result.updated_atstring(date-time)required

Last time object was updated

Response

application/json

{
  "result": {
    "id": "string",
    "fullname": "string",
    "environment": "test",
    "filters": [ … ],
    "url": "string",
    "credential_id": "string",
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Get Organization Webhook

Request

Returns the Webhook object matching {webhookId}.

Path

webhookIdstring(Id)required

curl -i -X GET \
  'https://api.synqly.com/v1/organization/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultobject(OrganizationWebhook)required

result.idstring(Id)required

result.fullnamestringrequired

Human friendly slug for this webhook

result.environmentstring(Environment)required

Enum"test""prod"

result.filtersArray of strings(WebhookFilter)required

Specifies which Webhooks to send.

Items Enum"all""account_create""account_delete""account_update""integration_create""integration_delete""integration_update""operation_complete"

result.urlstringrequired

URL that webhooks will be sent to

result.credential_idstring(Id)required

result.namestringrequired

Human-readable name for this resource

result.created_atstring(date-time)required

Time object was originally created

result.updated_atstring(date-time)required

Last time object was updated

Response

application/json

{
  "result": {
    "id": "string",
    "fullname": "string",
    "environment": "test",
    "filters": [ … ],
    "url": "string",
    "credential_id": "string",
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Update Organization Webhook

Request

Updates the Webhook object matching {webhookId}. For more information on Organizations and Webhooks, refer to our Synqly Overview.

Path

webhookIdstring(Id)required

Bodyapplication/jsonrequired

idstring(Id)required

fullnamestringrequired

Human friendly slug for this webhook

environmentstring(Environment)required

Enum"test""prod"

filtersArray of strings(WebhookFilter)required

Specifies which Webhooks to send.

Items Enum"all""account_create""account_delete""account_update""integration_create""integration_delete""integration_update""operation_complete"

urlstringrequired

URL that webhooks will be sent to

credential_idstring(Id)required

namestringrequired

Human-readable name for this resource

created_atstring(date-time)required

Time object was originally created

updated_atstring(date-time)required

Last time object was updated

curl -i -X PUT \
  'https://api.synqly.com/v1/organization/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "fullname": "string",
    "environment": "test",
    "filters": [
      "all"
    ],
    "url": "string",
    "credential_id": "string",
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }'

Responses

Bodyapplication/json

resultobject(OrganizationWebhook)required

result.idstring(Id)required

result.fullnamestringrequired

Human friendly slug for this webhook

result.environmentstring(Environment)required

Enum"test""prod"

result.filtersArray of strings(WebhookFilter)required

Specifies which Webhooks to send.

Items Enum"all""account_create""account_delete""account_update""integration_create""integration_delete""integration_update""operation_complete"

result.urlstringrequired

URL that webhooks will be sent to

result.credential_idstring(Id)required

result.namestringrequired

Human-readable name for this resource

result.created_atstring(date-time)required

Time object was originally created

result.updated_atstring(date-time)required

Last time object was updated

Response

application/json

{
  "result": {
    "id": "string",
    "fullname": "string",
    "environment": "test",
    "filters": [ … ],
    "url": "string",
    "credential_id": "string",
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Patch Organization Webhook

Request

Patches the Webhook object matching {webhookId}. For more information on Organizations and Webhooks, refer to our Synqly Overview.

Path

webhookIdstring(Id)required

Bodyapplication/jsonrequiredArray [

opstring(PatchOp)required

Enum"add""copy""move""remove""replace""test"

pathstringrequired

The path to the field to update. The path is a JSON Pointer.

fromstring or null

The path to the field to copy from. This is required for copy and move operations.

valueany or null

The value to set the field to. This is required for add, replace and test operations.

]

curl -i -X PATCH \
  'https://api.synqly.com/v1/organization/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "from": "string",
      "value": null
    }
  ]'

Responses

Bodyapplication/json

resultobject(OrganizationWebhook)required

result.idstring(Id)required

result.fullnamestringrequired

Human friendly slug for this webhook

result.environmentstring(Environment)required

Enum"test""prod"

result.filtersArray of strings(WebhookFilter)required

Specifies which Webhooks to send.

Items Enum"all""account_create""account_delete""account_update""integration_create""integration_delete""integration_update""operation_complete"

result.urlstringrequired

URL that webhooks will be sent to

result.credential_idstring(Id)required

result.namestringrequired

Human-readable name for this resource

result.created_atstring(date-time)required

Time object was originally created

result.updated_atstring(date-time)required

Last time object was updated

Response

application/json

{
  "result": {
    "id": "string",
    "fullname": "string",
    "environment": "test",
    "filters": [ … ],
    "url": "string",
    "credential_id": "string",
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Delete Organization Webhook

Request

Delete a webhook for the organization

Path

webhookIdstring(Id)required

curl -i -X DELETE \
  'https://api.synqly.com/v1/organization/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

Organization

Operations

Permissionset

Operations

Roles

Operations

Status

Operations

Sub Orgs

Operations

Tokens

Operations

Transforms

Operations

Management API

Accounts

Audit

Auth

Bridges

Capabilities

Credentials

Integration Points

Integrations

Members

Meta

Operations (In Development)

Organization Webhooks

List Organization Webhooks

Request

Responses

Was this helpful?

Create Organization Webhook

RequestExpand all

Responses

Was this helpful?

Get Organization Webhook

Request

Responses

Was this helpful?

Update Organization Webhook

Request

Responses

Was this helpful?

Patch Organization Webhook

Request

Responses

Was this helpful?

Delete Organization Webhook

Request

Responses

Was this helpful?

Organization

Permissionset

Roles

Status

Sub Orgs

Tokens

Transforms

Request