Skip to main content
API docs by Redocly

Interactor User Defined Automation Configuration and Execution API (6.1.0)

Download OpenAPI specification:Download

Interactor: info@interactor.com URL: https://interactor.com

The API allows configuration and execution of Interactor user automation.

User

Create a new user

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

Request Body schema: application/json
userId
required
string
email
string

This field cannot use duplicate emails.

name
string

Responses

Request samples

Content type
application/json
{
  • "id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "name": "my_user"
}

Response samples

Content type
application/json
{
  • "id": "051466ff-fb74-4128-96cf-cf1bad07fe6e"
}

Delete a single user

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

userId
required
string
Example: testUserId

User ID in path.

Responses

Get a single user

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

userId
required
string
Example: testUserId

User ID in path.

Responses

Response samples

Content type
application/json
{
  • "id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "name": "my_user"
}

Update a single user

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

userId
required
string
Example: testUserId

User ID in path.

Request Body schema: application/json
email
string

This field cannot use duplicate emails.

name
string

Responses

Request samples

Content type
application/json
{
  • "name": "updated user"
}

Group

Get all groups

This endpoint is used to get all groups. The groups are used to group users and services.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new group

This endpoint is used to create a new group. The groups are used to group users and services.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

Request Body schema: application/json
name
required
string
source
string
Enum: "local" "remote"
Authorization
object

Responses

Request samples

Content type
application/json
{
  • "name": "my_group"
}

Response samples

Content type
application/json
{
  • "id": "0fcc076c-02dd-4ebb-9408-ba3826feb717"
}

Get a single group

This endpoint is used to get a single group. The groups are used to group users and services.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

groupId
required
string
Example: testGroupId

Group ID in path.

Responses

Response samples

Content type
application/json
{
  • "id": "0fcc076c-02dd-4ebb-9408-ba3826feb717",
  • "name": "my_group",
  • "source": "local",
  • "authorization": { },
  • "updatedBy": "c3f42974-246c-4f48-865c-5f7e7a18f958",
  • "createdBy": "c3f42974-246c-4f48-865c-5f7e7a18f958",
  • "insertedAt": "22024-07-24T02:40:39",
  • "updatedAt": "22024-07-24T02:40:39"
}

Update a single group

This endpoint is used to update a single group. The groups are used to group users and services.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

groupId
required
string
Example: testGroupId

Group ID in path.

Request Body schema: application/json
name
string
source
string
Enum: "local" "remote"
authorization
object

Responses

Request samples

Content type
application/json
{
  • "name": "updated_group"
}

Delete a single group

This endpoint is used to delete a single group. The groups are used to group users and services.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

groupId
required
string
Example: testGroupId

Group ID in path.

Responses

Get all users in a group

This endpoint is used to get all users in a group. The groups are used to group users and services.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

groupId
required
string
Example: testGroupId

Group ID in path.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a user to a group

This endpoint is used to add a user to a group. The groups are used to group users and services.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

groupId
required
string
Example: testGroupId

Group ID in path.

Request Body schema: application/json
userId
required
string
role
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "name": "my_user"
}

Response samples

Content type
application/json
""

Get a single user in a group

This endpoint is used to get a single user in a group. The groups are used to group users and services.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

groupId
required
string
Example: testGroupId

Group ID in path.

userId
required
string
Example: testUserId

User ID in path.

Responses

Response samples

Content type
application/json
{
  • "role": "admin",
  • "updatedBy": "c7bdb19a-b522-48a4-8f41-d7fc586953aa",
  • "createdBy": "18b1d55a-81dd-4563-930d-7d8bdaa70f56",
  • "insertedAt": "22024-07-24T02:40:39",
  • "updatedAt": "22024-07-24T02:40:39",
  • "userId": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "groupId": "9d15458e-b358-4c00-ab03-17a5690aba56"
}

Update a single user in a group

This endpoint is used to update a single user in a group. The groups are used to group users and services.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

groupId
required
string
Example: testGroupId

Group ID in path.

userId
required
string
Example: testUserId

User ID in path.

Request Body schema: application/json
role
string

Responses

Request samples

Content type
application/json
{
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "role": "member",
  • "updatedBy": "c7bdb19a-b522-48a4-8f41-d7fc586953aa",
  • "createdBy": "18b1d55a-81dd-4563-930d-7d8bdaa70f56",
  • "insertedAt": "22024-07-24T02:40:39",
  • "updatedAt": "22024-07-24T02:40:39",
  • "userId": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "groupId": "9d15458e-b358-4c00-ab03-17a5690aba56"
}

Delete a single user in a group

This endpoint is used to delete a single user in a group. The groups are used to group users and services.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

groupId
required
string
Example: testGroupId

Group ID in path.

userId
required
string
Example: testUserId

User ID in path.

Responses

Execute

Execute automation manualy

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

automationId
required
string
Example: e343bfea-06b6-4da2-a8f8-2bb57e135eaf

Automation ID.

automationVersionId
required
string
Example: 1be79b21-487f-4cee-a744-261566077859

Automation Version ID.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "input": {
    }
}

Response samples

Content type
application/json
{
  • "input": {
    },
  • "output": "test-output"
}

Execute

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
@type
required
string
Value: "action"
service
required
string
serviceVersion
required
string
action
required
string
input
object
userCredentialId
string

Responses

Request samples

Content type
application/json
{
  • "@type": "action",
  • "service": "gmail",
  • "serviceVersion": "1.0.0",
  • "action": "email.send",
  • "actionVersion": "1.0.0",
  • "input": {
    },
  • "userCredentialId": "6b01414-f3e8-468b-ad27-0388dc0bee5c"
}

Response samples

Content type
application/json
{
  • "historyId": 41227,
  • "id": "1900bbb747117896",
  • "internalDate": 1718183752000,
  • "labelIds": [
    ],
  • "message_info": {
    },
  • "sizeEstimate": 111,
  • "snippet": "hello",
  • "threadId": "asdasd111"
}

Subscription

Create a new subscription for a given trigger

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

triggerId
required
string
Example: 23c299ad-ac41-46ce-99b1-67c9da3d2f7c

Trigger ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

userCredentialId
string
Example: userCredentialId=339453cd-f297-4cda-ae2b-379f2026b3b5

User Credential ID When you have multiple tokens for the service you are using, please use this.

Request Body schema: application/json
url
string
variables
object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "23c299ad-ac41-46ce-99b1-67c9da3d2f7c"
}

Get user subscriptions for a given userId

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Request samples 

curl --location --request GET 'http://localhost:1290/v1/subscription?userId=testUserId' \
--header 'Content-Type: application/json' \
--header 'api_key: default' \

Response samples

Content type
application/json
[
  • {
    }
]

Create new subscription with given body parameters

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
platform
required
string
service
required
string
userCredentialId
string
serviceVersion
string
trigger
required
string
url
required
string
variables
object

Responses

Request samples

Content type
application/json
{
  • "platform": "interactor",
  • "service": "googlecalendar",
  • "userCredentialId": "0fcc076c-02dd-4ebb-9408-ba3826feb717",
  • "serviceVersion": "1.0.0",
  • "trigger": "event.created",
  • "url": "http://localhost:1290/v1/echo",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "id": "e343bfea-06b6-4da2-a8f8-2bb57e135eaf"
}

Delete a subscription for a given subscription id

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

subscriptionId
required
string
Example: e343bfea-06b6-4da2-a8f8-2bb57e135eaf

Subscription ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Request samples 

curl --location --request DELETE 'http://localhost:1290/v1/subscription/97c73ca1-3941-4418-a32b-d5b46240911d?userId=testUserId' \
--header 'Content-Type: application/json' \
--header 'api_key: default' \

Response samples

Content type
application/json
""

Datatype

Get datatypes for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

Responses

Request samples 

curl --location 'localhost:1290/v1/service/gmail/datatype?userId=testUserId'

Response samples

Content type
application/json
[
  • {
    }
]

Create a new datatype for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
name
string
schema
object
logic
object

Responses

Request samples

Content type
application/json
{
  • "name": "TestDataType"
}

Response samples

Content type
application/json
{
  • "id": "bfd3b7c6-23e2-493f-a934-b61287b19e57"
}

Get a single datatype

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

datatypeId
required
string
Example: bfd3b7c6-23e2-493f-a934-b61287b19e57

Datatype ID.

Responses

Request samples 

curl --location 'localhost:1290/v1/service/gmail/datatype/testDataType?userId=testUserId'

Response samples

Content type
application/json
{
  • "id": "bfd3b7c6-23e2-493f-a934-b61287b19e57",
  • "name": "testDataType",
  • "updated_by": "my_user",
  • "created_by": "my_user",
  • "schema": { },
  • "service_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "published": true,
  • "logic": { },
  • "inserted_at": "2024-08-14T02:36:34",
  • "datatype_id": "05c75ebb-affe-49d8-acd6-b9c05a864dfc",
  • "updated_at": "2024-08-14T02:36:34"
}

Update a single datatype

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

datatypeId
required
string
Example: bfd3b7c6-23e2-493f-a934-b61287b19e57

Datatype ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

version
required
string
Example: version=1.0.0, minor, major

to update version name. for example specific version or suing minor or major

Request Body schema: application/json
name
string
schema
object
logic
object

Responses

Request samples

Content type
application/json
{
  • "name": "updatedDatatypeName",
  • "schema": { },
  • "logic": { }
}

Response samples

Content type
application/json
{
  • "id": "bfd3b7c6-23e2-493f-a934-b61287b19e57",
  • "name": "updatedDatatypeName",
  • "updated_by": "my_user",
  • "created_by": "my_user",
  • "schema": { },
  • "service_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "published": true,
  • "logic": { },
  • "inserted_at": "2024-08-14T02:36:34",
  • "datatype_id": "05c75ebb-affe-49d8-acd6-b9c05a864dfc",
  • "updated_at": "2024-08-14T02:36:34"
}

Delete a single datatype

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

datatypeId
required
string
Example: bfd3b7c6-23e2-493f-a934-b61287b19e57

Datatype ID.

Responses

Request samples 

curl --location --request DELETE 'localhost:1290/v1/service/gmail/datatype/dfb8888a-6dc1-4455-9d87-91d384d71f89?userId=testUserId'

Execute datatype version manualy

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

datatypeId
required
string
Example: bfd3b7c6-23e2-493f-a934-b61287b19e57

Datatype ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

userCredentialId
string
Example: userCredentialId=339453cd-f297-4cda-ae2b-379f2026b3b5

User Credential ID When you have multiple tokens for the service you are using, please use this.

Request Body schema: application/json
input
object

Responses

Request samples

Content type
application/json
{
  • "input": { }
}

Response samples

Content type
application/json
{
  • "input": { },
  • "output": {
    }
}

Token

Get tokens for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/googlecalendar/token?userId=hello%40interactor.com' \
--header 'api_key: default'

Response samples

Content type
application/json
[
  • {
    }
]

Get a single token

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

tokenId
required
string
Example: c6d6c3e3-b5b3-41d1-9393-54cc79fec492

Token ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Response samples

Content type
application/json
{
  • "id": "8ecef3d6-cee1-49d3-8802-cf6a2e7ad369",
  • "name": "MY_TOKEN"
}

Update a single token

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

tokenId
required
string
Example: c6d6c3e3-b5b3-41d1-9393-54cc79fec492

Token ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
type
string
Enum: "oauth" "api_key"
name
string

Token name

token
string

Token value

code
string

oauth code

tokenType
string

oauth type is Bearer, api_key does not have a token_type

refreshToken
string

oauth refresh token

serviceUrl
string

service url

Responses

Request samples

Content type
application/json
{
  • "name": "updated token"
}

Delete a single token

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

tokenId
required
string
Example: c6d6c3e3-b5b3-41d1-9393-54cc79fec492

Token ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Create User Token

This endpoint is used to create a new user Token. The user token are used to authenticate the user with the service. There are three types of user tokens - API Key and OAuth.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

userId
required
string
Example: testUserId

User ID in path.

Request Body schema:
name
string
serviceSecurityId
string
object

Responses

Request samples

Content type
{
  • "name": "hello@interactor.com",
  • "serviceSecurityId": "339453cd-f297-4cda-ae2b-379f2026b3b5",
  • "oauth": {
    }
}

Response samples

Content type
{
  • "id": "d4f51310-1bb9-44b0-8b9a-dd40699a34a3",
  • "name": "info@interactor.com",
  • "key": null,
  • "basic": null,
  • "oauth": {
    },
  • "userId": "339453cd-f297-4cda-ae2b-379f2026b3b5",
  • "serviceId": "339453cd-f297-4cda-ae2b-379f2026b3b5",
  • "insertedAt": "2024-07-22T03:16:22",
  • "updatedAt": "2024-07-22T03:16:22",
  • "virtualId": "339453cd-f297-4cda-ae2b-379f2026b3b5"
}

Oauth

Get service oauth url by id

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/051466ff-fb74-4128-96cf-cf1bad07fe6e/oauth?userId=testUserId' \
--header 'api_key: default'

Service

Get All services

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service' \
--header 'api_key: default'

Response samples

Content type
application/json
[]

Create a new service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
id
string
name
string
type
string
platformId
string
sharing
string
icon
string
displayOrder
integer
enabled
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "e343bfea-06b6-4da2-a8f8-2bb57e135eaf"
}

Get service by id

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/051466ff-fb74-4128-96cf-cf1bad07fe6e' \

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "name": "googlecalendar",
  • "type": "0",
  • "sharing": "none",
  • "icon": "https://interactor-service.s3.us-west-2.amazonaws.com/logo/googlecalendar.svg",
  • "insertedAt": "2024-01-01T00:00:00",
  • "updatedAt": "2024-07-23T03:30:17",
  • "updatedBy": "my_user",
  • "createdBy": "my_user",
  • "platformId": "interactor",
  • "defaultVersionId": "1be79b21-487f-4cee-a744-261566077859",
  • "displayOrder": 100
}

Update service details

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
id
string
name
string
type
string
platformId
string
sharing
string
icon
string
displayOrder
integer
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "updated service"
}

Delete service by id

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Request samples 

curl --location --request DELETE 'localhost:1290/v1/service/86e5d937-b8e9-4f06-8ced-eac513155a93?userId=2'

Publish Service

This endpoint is used to publish a service.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
contributor_id
required
string
Example: contributor_id=339453cd-f297-4cda-ae2b-379f2026b3b5

Contributor ID for publish service.

Responses

Request samples 

curl --location --request POST 'localhost:1290/v1/service/86e5d937-b8e9-4f06-8ced-eac513155a93/publish?contributor_id=da6f434d-e26f-4686-a222-8dc2ad4b14b6

Get service webhook url by id

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Request samples 

curl --location 'localhost:1290/v1/service/86e5d937-b8e9-4f06-8ced-eac513155a93/webhookSetting?userId=testUserId'

Get versions for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/gmail/version' \
--header 'api_key: default'

Response samples

Content type
application/json
[
  • {
    }
]

Create a new version of service

Create a new version of service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
id
string
name
string
object
published
boolean
logic
object
setting
object (serviceSetting)

Responses

Request samples

Content type
application/json
{
  • "name": "2",
  • "label": {
    },
  • "logic": { },
  • "setting": {
    }
}

Response samples

Content type
application/json
{
  • "id": "3d40cbbb-b5a9-4c86-8d2a-e7d3d3d4b9df"
}

Get a single version of service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

serviceVersionId
required
string
Example: 3d40cbbb-b5a9-4c86-8d2a-e7d3d3d4b9df, 1.0.0

Service Version ID. or You can user version name

Responses

Request samples 

curl --location 'localhost:1290/v1/service/gmail/version/?userId=834b068c-7259-471e-9024-760a9854efac'

Response samples

Content type
application/json
{
  • "id": "3d40cbbb-b5a9-4c86-8d2a-e7d3d3d4b9df",
  • "name": "1.0.0",
  • "label": {
    },
  • "published": true,
  • "logic": { },
  • "setting": {
    },
  • "insertedAt": "2024-01-01T00:00:00",
  • "createdBy": "my_user",
  • "updatedAt": "2024-01-01T00:00:00",
  • "updatedBy": "my_user",
  • "serviceId": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "defaultServiceSecurityId"": "3bf5b2fc-568b-470a-a1c3-ec355d778909"
}

Update a single version of service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

serviceVersionId
required
string
Example: 3d40cbbb-b5a9-4c86-8d2a-e7d3d3d4b9df, 1.0.0

Service Version ID. or You can user version name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
id
string
name
string
object
published
boolean
logic
object
setting
object (serviceSetting)

Responses

Request samples

Content type
application/json
{
  • "name": "11"
}

Delete a single version of service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

serviceVersionId
required
string
Example: 3d40cbbb-b5a9-4c86-8d2a-e7d3d3d4b9df, 1.0.0

Service Version ID. or You can user version name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Request samples 

curl --location --request DELETE 'localhost:1290/v1/service/gmail/version/3d40cbbb-b5a9-4c86-8d2a-e7d3d3d4b9df?userId=testUserId'

Security

Get all securitys for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

Responses

Request samples 

curl --location 'localhost:1290/v1/service/outlookmail/security'

Response samples

Content type
application/json
[
  • {
    }
]

Get a single security

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

securityId
required
string
Example: 339453cd-f297-4cda-ae2b-379f2026b3b5

Security ID.

Responses

Request samples 

curl --location 'localhost:1290/v1/service/da57dde4-9996-4f55-9738-0e0ce0f95572/security/0ba821ef-cbb9-40fe-a79a-c470f1d5cfb8?userId=testUserId'

Response samples

Content type
application/json
{
  • "id": "8e169418-71ad-4803-8eb0-425119bf47ae",
  • "label": {
    },
  • "scheme": "",
  • "config": { },
  • "insertedAt": "2024-01-01T00:00:00",
  • "updatedAt": "2024-01-01T00:00:00",
  • "serviceId": "051466ff-fb74-4128-96cf-cf1bad07fe6e"
}

Create a new security for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

securityId
required
string
Example: 339453cd-f297-4cda-ae2b-379f2026b3b5

Security ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
label
object
scheme
string
type
required
string
Enum: "oauth2" "apiKey"
config
object

Responses

Request samples

Content type
application/json
{
  • "label": {
    },
  • "type": "oauth2",
  • "config": { }
}

Response samples

Content type
application/json
{
  • "id": "8e169418-71ad-4803-8eb0-425119bf47ae"
}

Update a security for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

securityId
required
string
Example: 339453cd-f297-4cda-ae2b-379f2026b3b5

Security ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

version
required
string
Example: version=1.0.0, minor, major

to update version name. for example specific version or suing minor or major

Request Body schema: application/json
label
object
scheme
string
type
required
string
Enum: "oauth2" "apiKey"
config
object

Responses

Request samples

Content type
application/json
{
  • "label": {
    }
}

Response samples

Content type
application/json
{ }

Delete a security for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

securityId
required
string
Example: 339453cd-f297-4cda-ae2b-379f2026b3b5

Security ID.

Responses

Request samples 

curl --location --request DELETE 'localhost:1290/v1/service/da57dde4-9996-4f55-9738-0e0ce0f95572/security/0ba821ef-cbb9-40fe-a79a-c470f1d5cfb9?userId=testUserId'

Response samples

Content type
application/json
{ }

Variable

Get all variables for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

Responses

Request samples 

curl --location 'localhost:1290/v1/service/da57dde4-9996-4f55-9738-0e0ce0f95572/variable'

Response samples

Content type
application/json
[
  • {
    }
]

Get a single variable

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

variableId
required
string
Example: 339453cd-f297-4cda-ae2b-379f2026b3b5

Variable ID.

Responses

Request samples 

curl --location 'localhost:1290/v1/service/da57dde4-9996-4f55-9738-0e0ce0f95572/variable/996a4aad-34a0-46c6-b647-8ad261445cd4'

Response samples

Content type
application/json
{
  • "id": "8e169418-71ad-4803-8eb0-425119bf47ae",
  • "label": { },
  • "config": { },
  • "required": false,
  • "created_by": "5ec3fdcd-8ab0-4123-b8d8-91ce922cb955",
  • "inserted_at": "2024-01-01T00:00:00",
  • "updated_at": "2024-01-01T00:00:00",
  • "updated_by": "5ec3fdcd-8ab0-4123-b8d8-91ce922cb955",
  • "schema": {
    },
  • "service_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "published": true,
  • "component_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e"
}

Create a new variable for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
label
object
name
string
config
object
required
boolean
schema
object

Responses

Request samples

Content type
application/json
{
  • "label": { },
  • "config": { },
  • "required": false,
  • "schema": {
    }
}

Response samples

Content type
application/json
{
  • "id": "8e169418-71ad-4803-8eb0-425119bf47ae",
  • "label": { },
  • "config": { },
  • "required": false,
  • "created_by": "5ec3fdcd-8ab0-4123-b8d8-91ce922cb955",
  • "inserted_at": "2024-01-01T00:00:00",
  • "updated_at": "2024-01-01T00:00:00",
  • "updated_by": "5ec3fdcd-8ab0-4123-b8d8-91ce922cb955",
  • "schema": {
    },
  • "service_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "published": true,
  • "component_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e"
}

Update a variable for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

variableId
required
string
Example: 339453cd-f297-4cda-ae2b-379f2026b3b5

Variable ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

version
required
string
Example: version=1.0.0, minor, major

to update version name. for example specific version or suing minor or major

Request Body schema: application/json
label
object
name
string
config
object
required
boolean
schema
object

Responses

Request samples

Content type
application/json
{
  • "label": {
    }
}

Response samples

Content type
application/json
{
  • "id": "8e169418-71ad-4803-8eb0-425119bf47ae",
  • "label": { },
  • "config": { },
  • "required": false,
  • "created_by": "5ec3fdcd-8ab0-4123-b8d8-91ce922cb955",
  • "inserted_at": "2024-01-01T00:00:00",
  • "updated_at": "2024-01-01T00:00:00",
  • "updated_by": "5ec3fdcd-8ab0-4123-b8d8-91ce922cb955",
  • "schema": {
    },
  • "service_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "published": true,
  • "component_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e"
}

Delete a variable for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

variableId
required
string
Example: 339453cd-f297-4cda-ae2b-379f2026b3b5

Variable ID.

Responses

Request samples 

curl --location --request DELETE 'localhost:1290/v1/service/da57dde4-9996-4f55-9738-0e0ce0f95572/variable/996a4aad-34a0-46c6-b647-8ad261445cd4?userId=testUserId'

Response samples

Content type
application/json
{ }

Action

Get all actions for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/googlecalendar/action' \
--header 'api_key: default'

Response samples

Content type
application/json
[
  • {
    }
]

Create a new action for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
label
object
name
required
string
tag
Array of strings or null
schema
object
logic
object

Responses

Request samples

Content type
application/json
{
  • "id": "bfd3b7c6-23e2-493f-a934-b61287b19e57",
  • "name": "MY_ACTION"
}

Response samples

Content type
application/json
{
  • "id": "8e169418-71ad-4803-8eb0-425119bf47ae",
  • "label": {
    },
  • "name": "email.list",
  • "tag": null,
  • "created_by": "my_user",
  • "inserted_at": "2024-01-01T00:00:00",
  • "updated_at": "2024-01-01T00:00:00",
  • "updated_by": "my_user",
  • "schema": { },
  • "service_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "logic": { },
  • "published": true,
  • "component_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e"
}

Get a single action

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

actionId
required
string
Example: 00ffe293-db50-40fe-8654-31b2c512fd9d, event.create.simple

Action ID. or You can use action name

Responses

Request samples 

curl --location 'localhost:1290/v1/service/gmail/action/email.draft.create'

Response samples

Content type
application/json
{
  • "id": "bfd3b7c6-23e2-493f-a934-b61287b19e57",
  • "label": {
    },
  • "name": "email.draft.create",
  • "tag": null,
  • "updated_by": "my_user",
  • "created_by": "my_user",
  • "component_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "schema": { },
  • "service_id": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "published": true,
  • "logic": { },
  • "inserted_at": "2024-08-14T02:36:34",
  • "updated_at": "2024-08-14T02:36:34"
}

Update a single action

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

actionId
required
string
Example: 00ffe293-db50-40fe-8654-31b2c512fd9d, event.create.simple

Action ID. or You can use action name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

version
required
string
Example: version=1.0.0, minor, major

to update version name. for example specific version or suing minor or major

Request Body schema: application/json
id
string
label
object
name
string
tag
Array of strings or null
created_by
string
inserted_at
string
updated_at
string
updated_by
string
schema
object
service_id
string
logic
object
published
boolean
component_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "updated action"
}

Delete a single action

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

actionId
required
string
Example: 00ffe293-db50-40fe-8654-31b2c512fd9d, event.create.simple

Action ID. or You can use action name

Responses

Request samples 

curl --location --request DELETE 'localhost:1290/v1/service/gmail/action/email.draft.create?userId=testUserId'

Execute action version manualy

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

actionId
required
string
Example: 00ffe293-db50-40fe-8654-31b2c512fd9d, event.create.simple

Action ID. or You can use action name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

userCredentialId
string
Example: userCredentialId=339453cd-f297-4cda-ae2b-379f2026b3b5

User Credential ID When you have multiple tokens for the service you are using, please use this.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "calendar": "hello@gamil.com",
  • "summary": "test"
}

Response samples

Content type
application/json
{
  • "input": {
    },
  • "output": "test-output"
}

Refresh variables with new inputs

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

actionId
required
string
Example: 00ffe293-db50-40fe-8654-31b2c512fd9d, event.create.simple

Action ID. or You can use action name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
required
Array of objects (step)
targetField
required
string

Responses

Request samples

Content type
application/json
{
  • "step": [
    ],
  • "targetField": "issueType"
}

Response samples

Content type
application/json
{
  • "input": {
    },
  • "output": "test-output"
}

Event

Get All events for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/jira/event' \
--header 'api_key: default'

Response samples

Content type
application/json
[
  • {
    }
]

Create a new event for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
id
string
name
string
type
string
Enum: "standard" "automation" "target" "user" "serviceUrl"
config
object
updated_by
string
created_by
string
service_id
string
published
boolean
inserted_at
string
updated_at
string
setting
object
event_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "MY_EVENT",
  • "type": "webhook",
  • "config": { },
  • "logic": { },
  • "setting": { }
}

Response samples

Content type
application/json
{
  • "id": "62d4cdc8-8e99-40f9-a6de-851cc377463e",
  • "name": "notification",
  • "type": "webhook",
  • "config": { },
  • "updated_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "created_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "service_id": "47df3044-5675-4375-afe4-5c53affeb3dc",
  • "published": false,
  • "logic": { },
  • "inserted_at": "2024-01-01T00:00:00",
  • "updated_at": "2024-01-01T00:00:00",
  • "setting": { },
  • "event_id": "62d4cdc8-8e99-40f9-a6de-851cc377463e"
}

Get a single event

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

eventId
required
string
Example: 62d4cdc8-8e99-40f9-a6de-851cc377463e

Event ID Also, You can use event's Name instead of using eventId.

Responses

Request samples 

curl --location 'localhost:1290/v1/service/gmail/event/notification?userId=834b068c-7259-471e-9024-760a9854efac'

Response samples

Content type
application/json
{
  • "id": "62d4cdc8-8e99-40f9-a6de-851cc377463e",
  • "name": "MY_EVENT",
  • "type": "webhook",
  • "config": { },
  • "updated_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "created_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "published": false,
  • "service_id": "47df3044-5675-4375-afe4-5c53affeb3dc",
  • "logic": { },
  • "inserted_at": "2024-01-01T00:00:00",
  • "updated_at": "2024-01-01T00:00:00",
  • "setting": { },
  • "event_id": "62d4cdc8-8e99-40f9-a6de-851cc377463e"
}

Update a single event

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

eventId
required
string
Example: 62d4cdc8-8e99-40f9-a6de-851cc377463e

Event ID Also, You can use event's Name instead of using eventId.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
id
string
name
string
type
string
Enum: "standard" "automation" "target" "user" "serviceUrl"
config
object
updated_by
string
created_by
string
service_id
string
published
boolean
inserted_at
string
updated_at
string
setting
object
event_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "updatedEvent",
  • "type": "standard"
}

Response samples

Content type
application/json
{
  • "id": "62d4cdc8-8e99-40f9-a6de-851cc377463e",
  • "name": "MY_EVENT",
  • "type": "webhook",
  • "config": { },
  • "updated_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "created_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "published": false,
  • "service_id": "47df3044-5675-4375-afe4-5c53affeb3dc",
  • "logic": { },
  • "inserted_at": "2024-01-01T00:00:00",
  • "updated_at": "2024-01-01T00:00:00",
  • "setting": { },
  • "event_id": "62d4cdc8-8e99-40f9-a6de-851cc377463e"
}

Delete a single event

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

eventId
required
string
Example: 62d4cdc8-8e99-40f9-a6de-851cc377463e

Event ID Also, You can use event's Name instead of using eventId.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Request samples 

curl --location --request DELETE 'localhost:1290/v1/service/gmail/event/ecd55aaa-7846-4bbf-8092-b753f96955c4?userId=testUserId'

Trigger

Get All triggers for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/googlecalendar/trigger' \

Response samples

Content type
application/json
[
  • {
    }
]

Create a new trigger for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
label
object
name
string
schema
object
logic
object

Responses

Request samples

Content type
application/json
{
  • "label": {
    },
  • "name": "email.deleted",
  • "schema": { },
  • "logic": { },
  • "trigger_id": "62d4cdc8-8e99-40f9-a6de-851cc377463e"
}

Response samples

Content type
application/json
{
  • "id": "e48694bc-212e-4c96-8f2a-b26b65cd639e",
  • "label": {
    },
  • "name": "email.deleted",
  • "updated_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "created_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "schema": { },
  • "published": true,
  • "service_id": "47df3044-5675-4375-afe4-5c53affeb3dc",
  • "logic": { },
  • "trigger_id": "62d4cdc8-8e99-40f9-a6de-851cc377463e",
  • "inserted_at": "2024-01-01T00:00:00",
  • "updated_at": "2024-01-01T00:00:00"
}

Get a single trigger

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

triggerId
required
string
Example: 23c299ad-ac41-46ce-99b1-67c9da3d2f7c

Trigger ID.

Responses

Request samples 

curl --location 'localhost:1290/v1/service/gmail/trigger/email.sent?userId=testUserId'

Response samples

Content type
application/json
{
  • "id": "e48694bc-212e-4c96-8f2a-b26b65cd639e",
  • "label": {
    },
  • "name": "email.sent",
  • "updated_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "created_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "schema": { },
  • "published": true,
  • "service_id": "47df3044-5675-4375-afe4-5c53affeb3dc",
  • "logic": { },
  • "trigger_id": "62d4cdc8-8e99-40f9-a6de-851cc377463e",
  • "inserted_at": "2024-01-01T00:00:00",
  • "updated_at": "2024-01-01T00:00:00"
}

Update a single trigger

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

triggerId
required
string
Example: 23c299ad-ac41-46ce-99b1-67c9da3d2f7c

Trigger ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
id
string
label
object
name
string
updated_by
string
created_by
string
schema
object
published
boolean
service_id
string
logic
object
trigger_id
string
inserted_at
string
updated_at
string

Responses

Request samples

Content type
application/json
{
  • "name": "updated.trigger"
}

Response samples

Content type
application/json
{
  • "id": "e48694bc-212e-4c96-8f2a-b26b65cd639e",
  • "label": {
    },
  • "name": "email.sent",
  • "updated_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "created_by": "0caf50b3-5e1d-4235-883b-b042d0fe2298",
  • "schema": { },
  • "published": true,
  • "service_id": "47df3044-5675-4375-afe4-5c53affeb3dc",
  • "logic": { },
  • "trigger_id": "62d4cdc8-8e99-40f9-a6de-851cc377463e",
  • "inserted_at": "2024-01-01T00:00:00",
  • "updated_at": "2024-01-01T00:00:00"
}

Delete a single trigger

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

triggerId
required
string
Example: 23c299ad-ac41-46ce-99b1-67c9da3d2f7c

Trigger ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Condition

Get conditions for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new condition for a given service

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
name
string
label
object
schema
object
logic
object

Responses

Request samples

Content type
application/json
{
  • "id": "809653ba-440f-439a-b8c1-dd98ea1e814e",
  • "name": "MY_CONDITION"
}

Response samples

Content type
application/json
{
  • "id": "809653ba-440f-439a-b8c1-dd98ea1e814e"
}

Delete a single condition

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

condition_id
required
string
Example: 809653ba-440f-439a-b8c1-dd98ea1e814e

Condition ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Get a single condition

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

condition_id
required
string
Example: 809653ba-440f-439a-b8c1-dd98ea1e814e

Condition ID.

Responses

Response samples

Content type
application/json
{
  • "id": "809653ba-440f-439a-b8c1-dd98ea1e814e",
  • "name": "MY_CONDITION",
  • "insertedAt": "2024-01-01T00:00:00",
  • "createdBy": "my_user",
  • "updatedAt": "2024-01-01T00:00:00",
  • "updatedBy": "my_user",
  • "serviceId": "47df3044-5675-4375-afe4-5c53affeb3dc"
}

Update a single condition

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

serviceId
required
string
Example: 051466ff-fb74-4128-96cf-cf1bad07fe6e, gmail

Service ID. or You can use service name

condition_id
required
string
Example: 809653ba-440f-439a-b8c1-dd98ea1e814e

Condition ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
id
string
name
string
service_id
string
created_by
string
updated_by
string
inserted_at
string
updated_at
string
schema
object
logic
object
published
boolean
condition_id
string
label
object

Responses

Request samples

Content type
application/json
{
  • "name": "updated condition"
}

Test

Test logic based on given table

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

Request Body schema: application/json
table
string
id
string
record_path
Array of arrays
data
object
source
Array of arrays

Responses

Request samples

Content type
application/json
Example
{
  • "table": "ActionVersion",
  • "id": "c769d0d9-aedb-44a8-beb4-ac9295ecbeca",
  • "data": {
    },
  • "source": [
    ]
}

Response samples

Content type
application/json
"adc"

Test notification based on given request

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
""