Skip to main content
API docs by Redocly

Interactor User Defined Automation Configuration and Execution API (6.0.9)

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 'http://localhost:1290/v1/service/googlecalendar/datatype?byName=true&userId=testUserId' \
--header 'api_key: default'

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

Responses

Request samples

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

Response samples

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

Get versions for a given 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 'http://localhost:1290/v1/service/googlecalendar/datatype/GoogleCalendarAttendee/version?byName=true' \
--header 'api_key: default'

Response samples

Content type
application/json
[
  • {
    }
]

Create a new version for a given 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.

Request Body schema: application/json
id
string
name
string
schema
object (schema)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "2043154b-2839-481d-ab6d-f3aea05c3a29"
}

Delete a single version of 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.

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

Datatype Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/googlecalendar/datatype/GoogleCalendar/version/0?byName=true&userId=testUserId' \
--header 'api_key: default' \

Get a single version of 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.

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

Datatype Version ID.

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/googlecalendar/datatype/GoogleCalendarAttendee/version?byName=true' \
--header 'api_key: default'

Response samples

Content type
application/json
{
  • "id": "9b757d78-446e-4e6a-9a66-fb06c322a531",
  • "name": "1.0.0",
  • "schema": {
    },
  • "logic": { },
  • "createdBy": "5ec3fdcd-8ab0-4123-b8d8-91ce922cb955",
  • "insertedAt": "2024-04-16T00:45:53",
  • "updatedAt": "2024-04-16T00:45:53",
  • "updatedBy": "5ec3fdcd-8ab0-4123-b8d8-91ce922cb955",
  • "datatypeId": "41173e9d-dd0f-4fbc-99f9-3afcf4aef731"
}

Update a single version of 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.

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

Datatype Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
id
string
name
string
schema
object (schema)

Responses

Request samples

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

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
{
  • "items": [
    ]
}

Execute datatype version manualy with service version

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

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

Datatype ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
input
object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "items": [
    ]
}

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/a2c8137a-a688-471c-aa45-8cadafda003c/token?userId=testUserId' \
--header 'api_key: default'

Response samples

Content type
application/json
[
  • {
    }
]

Create a new token 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
type
required
string
Enum: "oauth" "api_key"
name
required
string

Token name

token
required
string

Token value

code
string

oauth code

tokenType
string

oauth type is Bearer / api_key type does not have a token_type

refreshToken
string

oauth refresh token

serviceUrl
string

service url

Responses

Request samples

Content type
application/json
Example
{
  • "type": "oauth",
  • "name": "hello@gmail.com",
  • "token": "iwKICJleHAiOiAxMzExMjgxOTcwLAogImlhdCI6IDEzMTEyODA5Nz",
  • "code": "OTcwLAogImlhdC",
  • "token_type": "Bearer",
  • "refresh_token": "1/0xJU",
  • "service_url": "hello"
}

Response samples

Content type
application/json
{
  • "id": "c6d6c3e3-b5b3-41d1-9393-54cc79fec492"
}

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

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

Upsert User Credential

This endpoint is used to upsert user credentials. The user credentials are used to authenticate the user with the service. There are three types of user credentials - API Key, Basic Auth, 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
required
string
required
object
serviceId
required
string

Responses

Request samples

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

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

Get user's all credentials for a given user

This endpoint is used to get all user credentials. The user credentials are used to authenticate the user with the service. There are three types of user credentials - API Key, Basic Auth, and OAuth.

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
[
  • {
    }
]

Delete a single user credential

This endpoint is used to delete a single user credential. The user credentials are used to authenticate the user with the service.

path Parameters
apiVersion
required
string
Example: v1

Interactor API Version.

userId
required
string
Example: testUserId

User ID in path.

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

Credential ID.

Responses

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'

Get service oauth url by id with service version

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.

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.

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/051466ff-fb74-4128-96cf-cf1bad07fe6e/version/3d40cbbb-b5a9-4c86-8d2a-e7d3d3d4b9df/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
platform_id
string
sharing
string
icon
string
display_order
integer
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "MY_SERVICE",
  • "platform_id": "interactor",
  • "enabled": true,
  • "sharing": "none",
  • "type": "0"
}

Response samples

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

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

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

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
platform_id
string
sharing
string
icon
string
display_order
integer
enabled
boolean

Responses

Request samples

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

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

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/42afd2c7-817f-45d5-a747-34507559807c/version' \
--header 'api_key: default'

Response samples

Content type
application/json
[
  • {
    }
]

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 (serviceAuth)
variables
object (serviceVariables)
setting
object (serviceSetting)
auth_type
string

Responses

Request samples

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

Response samples

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

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

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

Response samples

Content type
application/json
{
  • "id": "3d40cbbb-b5a9-4c86-8d2a-e7d3d3d4b9df",
  • "label": {
    },
  • "name": "1.0.0",
  • "auth": { },
  • "variables": { },
  • "insertedAt": "2024-01-01T00:00:00",
  • "setting": { },
  • "createdBy": "user-0000-0000-0000-000000000000",
  • "updatedAt": "2024-01-01T00:00:00",
  • "updatedBy": "user-0000-0000-0000-000000000000",
  • "serviceId": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "authType": ""
}

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 (serviceAuth)
variables
object (serviceVariables)
setting
object (serviceSetting)
auth_type
string

Responses

Request samples

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

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?byName=true&expand=true' \
--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
id
required
string
name
required
string

Responses

Request samples

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

Response samples

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

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

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

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

Response samples

Content type
application/json
{
  • "id": "bfd3b7c6-23e2-493f-a934-b61287b19e57",
  • "name": "MY_ACTION",
  • "serviceId": "051466ff-fb74-4128-96cf-cf1bad07fe6e",
  • "createdBy": "my_user",
  • "updatedBy": "my_user",
  • "insertedAt": "2024-01-01T00:00:00",
  • "updatedAt": "2024-01-01T00:00:00"
}

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.

Request Body schema: application/json
name
string

Responses

Request samples

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

Get versions for a given 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 'http://localhost:1290/v1/service/a2c8137a-a688-471c-aa45-8cadafda003c/action/00ffe293-db50-40fe-8654-31b2c512fd9d/version' \
--header 'api_key: default'

Response samples

Content type
application/json
[
  • {
    }
]

Create a new version for a given 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.

Request Body schema: application/json
id
required
string
name
required
string
logic
required
object (logic)
object
schema
object (schema)

Responses

Request samples

Content type
application/json
{
  • "id": "2043154b-2839-481d-ab6d-f3aea05c3a29",
  • "name": "1.0.0",
  • "logic": {
    }
}

Response samples

Content type
application/json
{
  • "id": "2043154b-2839-481d-ab6d-f3aea05c3a29"
}

Delete a single version of 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

actionVersionId
required
string
Example: 2043154b-2839-481d-ab6d-f3aea05c3a29

Action Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Get a single version of 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

actionVersionId
required
string
Example: 2043154b-2839-481d-ab6d-f3aea05c3a29

Action Version ID.

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/3ceef211-22c8-48e5-b281-dbf874699647/action/16c8fef4-37b3-4267-84a4-106f5628684f/version/70027275-49ef-48c5-8e5b-df2872e3e578' \
--header 'api_key: default'

Response samples

Content type
application/json
{
  • "id": "2043154b-2839-481d-ab6d-f3aea05c3a29",
  • "name": "1.0.0",
  • "logic": {
    },
  • "schema": { },
  • "createdBy": "user-0000-0000-0000-000000000000",
  • "updatedBy": "user-0000-0000-0000-000000000000",
  • "actionId": "bfd3b7c6-23e2-493f-a934-b61287b19e57",
  • "insertedAt": "2024-01-01T00:00:00",
  • "updatedAt": "2024-01-01T00:00:00"
}

Update a single version of 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

actionVersionId
required
string
Example: 2043154b-2839-481d-ab6d-f3aea05c3a29

Action Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

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

Responses

Request samples

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

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

Execute action version manualy with service version

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

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

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
id
string
name
string
serviceId
string
createdBy
string
updatedBy
string
insertedAt
string
updatedAt
string

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
serviceId
string
createdBy
string
updatedBy
string
insertedAt
string
updatedAt
string

Responses

Request samples

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

Get versions for a given 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
[
  • {
    }
]

Create a new version for a given 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
logic
object (logic)
schema
object (schema)
createdBy
string
updatedBy
string
condition_id
string
insertedAt
string
updatedAt
string
condition_target
string

Responses

Request samples

Content type
application/json
{
  • "id": "7786423f-6150-413a-a396-06c02c709603",
  • "name": "1.0.0",
  • "logic": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7786423f-6150-413a-a396-06c02c709603"
}

Delete a single version of 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.

condition_version_id
required
string
Example: 7786423f-6150-413a-a396-06c02c709603

Condition Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Get a single version of 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.

condition_version_id
required
string
Example: 7786423f-6150-413a-a396-06c02c709603

Condition Version ID.

Responses

Response samples

Content type
application/json
{
  • "id": "7786423f-6150-413a-a396-06c02c709603",
  • "name": "1.0.0",
  • "logic": {
    },
  • "schema": { },
  • "createdBy": "user-0000-0000-0000-000000000000",
  • "updatedBy": "user-0000-0000-0000-000000000000",
  • "condition_id": "809653ba-440f-439a-b8c1-dd98ea1e814e",
  • "insertedAt": "2024-01-01T00:00:00",
  • "updatedAt": "2024-01-01T00:00:00"
}

Update a single version of 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.

condition_version_id
required
string
Example: 7786423f-6150-413a-a396-06c02c709603

Condition Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Request Body schema: application/json
id
string
name
string
logic
object (logic)
schema
object (schema)
createdBy
string
updatedBy
string
condition_id
string
insertedAt
string
updatedAt
string
condition_target
string

Responses

Request samples

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

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
name
string
id
string

Responses

Request samples

Content type
application/json
{
  • "id": "62d4cdc8-8e99-40f9-a6de-851cc377463e",
  • "name": "MY_EVENT"
}

Response samples

Content type
application/json
{
  • "id": "62d4cdc8-8e99-40f9-a6de-851cc377463e",
  • "name": "notification"
}

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

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

Response samples

Content type
application/json
{
  • "id": "62d4cdc8-8e99-40f9-a6de-851cc377463e",
  • "name": "MY_EVENT",
  • "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 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
name
string

Responses

Request samples

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

Get versions for a given 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

Response samples

Content type
application/json
[
  • {
    }
]

Create a new version for a given 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
required
string
name
required
string
logic
object (logic)

Responses

Request samples

Content type
application/json
{
  • "id": "ee971c9c-952f-43d4-b91a-cdad2ef0c12f",
  • "name": "1.0.0",
  • "logic": {
    }
}

Response samples

Content type
application/json
{
  • "id": "ee971c9c-952f-43d4-b91a-cdad2ef0c12f"
}

Delete a single version of 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.

eventVersionId
required
string
Example: ee971c9c-952f-43d4-b91a-cdad2ef0c12f

Event Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Get a single version of 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.

eventVersionId
required
string
Example: ee971c9c-952f-43d4-b91a-cdad2ef0c12f

Event Version ID.

Responses

Response samples

Content type
application/json
{
  • "id": "ee971c9c-952f-43d4-b91a-cdad2ef0c12f",
  • "name": "1.0.0",
  • "logic": {
    },
  • "setting": { },
  • "type": "webhook",
  • "config": { },
  • "createdBy": "user-0000-0000-0000-000000000000",
  • "updatedBy": "user-0000-0000-0000-000000000000",
  • "eventId": "62d4cdc8-8e99-40f9-a6de-851cc377463e",
  • "insertedAt": "2024-01-01T00:00:00",
  • "updatedAt": "2024-01-01T00:00:00"
}

Update a single version of 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.

eventVersionId
required
string
Example: ee971c9c-952f-43d4-b91a-cdad2ef0c12f

Event Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

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

Responses

Request samples

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

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' \
--header 'api_key: default'

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
name
string
id
string

Responses

Request samples

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

Response samples

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

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

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

Response samples

Content type
application/json
{
  • "id": "23c299ad-ac41-46ce-99b1-67c9da3d2f7c",
  • "name": "MY_TRIGGER",
  • "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 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
name
string

Responses

Request samples

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

Get All versions 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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new version 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.

Request Body schema: application/json
id
required
string
name
required
string
logic
required
object (logic)
object
schema
object (schema)

Responses

Request samples

Content type
application/json
{
  • "id": "7613cfd4-633e-44b3-b8b9-5f356b023509",
  • "name": "1.0.0",
  • "logic": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7613cfd4-633e-44b3-b8b9-5f356b023509"
}

Delete a single version of 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.

triggerVersionId
required
string
Example: 7613cfd4-633e-44b3-b8b9-5f356b023509

Trigger Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Get a single version of 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.

triggerVersionId
required
string
Example: 7613cfd4-633e-44b3-b8b9-5f356b023509

Trigger Version ID.

Responses

Request samples 

curl --location 'http://localhost:1290/v1/service/googlecalendar/trigger/event.created/version/86acb211-83dc-47cf-b219-db6896351f11' \
--header 'api_key: default'

Response samples

Content type
application/json
{
  • "id": "7613cfd4-633e-44b3-b8b9-5f356b023509",
  • "name": "1.0.0",
  • "logic": {
    },
  • "schema": { },
  • "createdBy": "user-0000-0000-0000-000000000000",
  • "updatedBy": "user-0000-0000-0000-000000000000",
  • "triggerId": "23c299ad-ac41-46ce-99b1-67c9da3d2f7c",
  • "insertedAt": "2024-01-01T00:00:00",
  • "updatedAt": "2024-01-01T00:00:00"
}

Update a single version of 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.

triggerVersionId
required
string
Example: 7613cfd4-633e-44b3-b8b9-5f356b023509

Trigger Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

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

Responses

Request samples

Content type
application/json
{
  • "name": "1.0.1",
  • "lable": {
    }
}

Get trigger 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

Responses

Response samples

Service Version to Operation Version

Get action versions for a given service version

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 'http://localhost:1290/v1/service/a2c8137a-a688-471c-aa45-8cadafda003c/version/42afd2c7-817f-45d5-a747-34507559807c/action?userId=testUserId' \
--header 'api_key: default'

Response samples

Content type
application/json
[
  • {
    }
]

Create a new version link for service and 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

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

Service Version ID. or You can user version name

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

Action ID. or You can use action name

actionVersionId
required
string
Example: 2043154b-2839-481d-ab6d-f3aea05c3a29

Action Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Delete a single version link for service and 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

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

Service Version ID. or You can user version name

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

Action ID. or You can use action name

actionVersionId
required
string
Example: 2043154b-2839-481d-ab6d-f3aea05c3a29

Action Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Get condition versions for a given service version

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

Response samples

Content type
application/json
[
  • {
    }
]

Create a new version link for service and 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

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

Service Version ID. or You can user version name

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

Condition ID.

condition_version_id
required
string
Example: 7786423f-6150-413a-a396-06c02c709603

Condition Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Delete a single version link for service and 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

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

Service Version ID. or You can user version name

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

Condition ID.

condition_version_id
required
string
Example: 7786423f-6150-413a-a396-06c02c709603

Condition Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Get event versions for a given service version

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

Response samples

Content type
application/json
[
  • {
    }
]

Create a new version link for service and 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

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

Service Version ID. or You can user version name

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

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

eventVersionId
required
string
Example: ee971c9c-952f-43d4-b91a-cdad2ef0c12f

Event Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Delete a single version link for service and 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

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

Service Version ID. or You can user version name

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

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

eventVersionId
required
string
Example: ee971c9c-952f-43d4-b91a-cdad2ef0c12f

Event Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Get trigger versions for a given service version

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

Response samples

Content type
application/json
[
  • {
    }
]

Create a new version link for service and 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

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

Service Version ID. or You can user version name

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

Trigger ID.

triggerVersionId
required
string
Example: 7613cfd4-633e-44b3-b8b9-5f356b023509

Trigger Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

Delete a single version link for service and 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

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

Service Version ID. or You can user version name

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

Trigger ID.

triggerVersionId
required
string
Example: 7613cfd4-633e-44b3-b8b9-5f356b023509

Trigger Version ID.

query Parameters
userId
required
string
Example: userId=testUserId

User ID in query.

Responses

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