Open API Reference
Welcome
Endpoint
https://open.api.woztell.com/v3
Open API is built around GraphQL.
Open API is built around GraphQL. It is recommended to have prior knowledge of GraphQL in order to make use of the Open API.
You can visit our Open API Playground, where you can test our Open API. For your reference, API Documentation and Schema are also available at the right side of the playground.
Authentication
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>
-
Follow this guide to generate an access token from your WOZTELL app.
-
In the Open API playground, insert the access token into the HTTP HEADERS.
How to test our API calls?
- Write your query on the left panel. You can try with the following call to get conversation history.
query getChatHistory (: IntMax100) {
apiViewer {
conversationHistory (first: ) {
edges {
node {
messageEvent
}
}
}
}
}
- You can refer to the SCHEMA and DOCS for other query types.
- Varaiables can be entered in the QUERY VARIABLES.
- Click the button to test the API call, the response will be displayed on the right panel.
Rate Limit
There are rate limits on our API calls. After sending an API call to WOZTELL with GraphQL Client (e.g. Postman), you can view the rate limit in Response Headers:
X-RateLimit-Remaining: The count of API calls that you can send in a minute
X-RateLimit-Limit: The count of API calls sent in a minute
Retry-After: The time needed until the next call after reaching the rate limit (in seconds)
Queries
apiViewer
Example
Query
query ApiViewer($appId: ID) {
apiViewer(appId: $appId) {
id
_id
distinctDataSourceData
fetchDataSourceData
fetchGeoNearDataSourceData
memberRaw
member {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
channel {
...ChannelFragment
}
channelId
platform
profile {
...MemberProfileFragment
}
inboxProfile {
...InboxMemberProfileFragment
}
tags
meta
botMeta {
...BotMetaFragment
}
externalId
botId
admin {
...AdminFragment
}
adminId
group {
...GroupFragment
}
assignment
fbId
name
firstName
lastName
profilePic
gender
customLocale
locale
email
profilePicString
inletGroup
fbOTNTokens {
...FbOTNTokenFragment
}
notes {
...NoteFragment
}
etag
}
members {
edges {
...MemberEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
admins {
edges {
...AdminEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
conversationHistory {
edges {
...ChatEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
assignments {
edges {
...AssignmentEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
assignment {
id
_id
createdAt
updatedAt
inlet {
...ChannelFragment
}
inletId
targets {
...AssignmentTargetFragment
}
member {
...MemberFragment
}
memberId
group {
...GroupFragment
}
groupId
groupExternalId
assignedAt
assignee {
...AdminFragment
}
assigner {
...AdminFragment
}
expiry
groupInfo
relayMessage
reassignRelayMessage
takenMessage
app {
...AppFragment
}
appId
etag
tags
inactivatedAt
reassign
history
active
inletGroup
inletMessage
inletGroupInfo
inletGroupExternalId
parentAssignment {
...AssignmentFragment
}
parentAssignmentId
previousAssignment {
...AssignmentFragment
}
previousAssignmentId
adminContactMessage
redirectMemberToNode {
...RedirectFragment
}
label
status
meta
isZendesk
noGroupCreation
}
groups {
edges {
...GroupEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
installedIntegrations {
_id
id
app {
...AppFragment
}
appId
description
alias
meta
integration_id
integrationKey
integrationId
features
build
etag
createdAt
updatedAt
signature
secret
channel {
...ChannelFragment
}
integrationName
integrationDescription
latestPublished
isLatestPublished
icon
author {
...AuthorFragment
}
authorId
supportEmail
readme
termsAndConditionsUrl
privacyPolicyUrl
websiteUrl
builderSidebarView {
...IntegrationViewFragment
}
dashboardView {
...IntegrationViewFragment
}
customView {
...IntegrationViewFragment
}
changelog
scopes
endpoints {
...IntegrationEndpointsFragment
}
resourceTemplates {
...ResourceTemplateFragment
}
defaultResourceTemplate {
...ResourceTemplateFragment
}
hooks {
...HookFragment
}
functionString
settingsView
platformSettingsView
settingsSchema
settingsValidatorFunctionString
trees {
...IntegrationTreeFragment
}
supportTicketing
version
inbox {
...InboxIntegrationFragment
}
}
installedIntegration {
_id
id
app {
...AppFragment
}
appId
description
alias
meta
integration_id
integrationKey
integrationId
features
build
etag
createdAt
updatedAt
signature
secret
channel {
...ChannelFragment
}
integrationName
integrationDescription
latestPublished
isLatestPublished
icon
author {
...AuthorFragment
}
authorId
supportEmail
readme
termsAndConditionsUrl
privacyPolicyUrl
websiteUrl
builderSidebarView {
...IntegrationViewFragment
}
dashboardView {
...IntegrationViewFragment
}
customView {
...IntegrationViewFragment
}
changelog
scopes
endpoints {
...IntegrationEndpointsFragment
}
resourceTemplates {
...ResourceTemplateFragment
}
defaultResourceTemplate {
...ResourceTemplateFragment
}
hooks {
...HookFragment
}
functionString
settingsView
platformSettingsView
settingsSchema
settingsValidatorFunctionString
trees {
...IntegrationTreeFragment
}
supportTicketing
version
inbox {
...InboxIntegrationFragment
}
}
integrations
app {
id
_id
createdAt
updatedAt
name
description
inlets {
...ChannelFragment
}
outlets {
...ChannelFragment
}
meta
integrations
activated
teamMembers {
...TeamMemberFragment
}
dataSources {
...DataSourceFragment
}
dataSource {
...DataSourceFragment
}
pairs {
...PairFragment
}
managedBy {
...PartnerFragment
}
managementType
etag
}
userContext
channels {
edges {
...ChannelEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
tree {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
globalNodes {
...NodeObjectFragment
}
globalNodeIds
nodes {
...NodeObjectFragment
}
nodeIds
workspace {
...WorkspaceFragment
}
version
versionAlias
ancestorTree {
...TreeFragment
}
siblingTrees {
...TreeFragment
}
tags
stash {
...NodeObjectFragment
}
etag
configMapSchema
configMap
type
system
templateTreeId
templateTree {
...TreeFragment
}
locked
}
whatsAppFile {
ok
err_code
err
url
}
whatsAppTemplate {
edges {
...WhatsAppMessageTemplateEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
postCommentAnalyticsOverview {
edges {
...PostCommentAnalyticsOverviewEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nlpAnalyticsOverview {
edges {
...NLPAnalyticsCounterEdgeFragment
}
total_no_of_nlp_analytics
pageInfo {
...PageInfoFragment
}
}
analyticsCustomEventOverviewDateHistogram {
edges {
...AnalyticsCustomEventCounterEdgeTBFragment
}
total_no_of_analytics
pageInfo {
...PageInfoFragment
}
}
analyticsCustomEventOverviewTable {
edges {
...AnalyticsCustomEventCounterEdgeRDFragment
}
total_no_of_analytics
pageInfo {
...PageInfoFragment
}
}
dailyActiveMemberOverview {
data {
...DailyActiveMemberRowFragment
}
pageInfo {
...PageInfoFragment
}
}
activeMemberCounter {
data {
...ActiveMemberCounterFragment
}
pageInfo {
...PageInfoFragment
}
total_no_of_member
total_no_of_comment_member
}
newMemberCounter {
data {
...NewMemberCounterFragment
}
pageInfo {
...PageInfoFragment
}
total_no_of_member
total_no_of_comment_member
}
actions {
edges {
...ActionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
audiences {
edges {
...AudienceEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
conditions {
edges {
...ConditionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
localeGroups {
edges {
...LocaleGroupEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nodes {
edges {
...NodeObjectEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
priorityGroups {
edges {
...PriorityGroupEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
responses {
edges {
...ResponseEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
subscriptionPushes {
edges {
...SubscriptionPushEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
trees {
edges {
...TreeEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
triggers {
edges {
...TriggerEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
file {
fileId
fileType
url
size
}
chat {
id
_id
createdAt
updatedAt
sentAt
readAt
deliveredAt
deletedAt
group {
...GroupFragment
}
assignment {
...AssignmentFragment
}
messageEvent
from
member {
...MemberFragment
}
memberId
admin {
...AdminFragment
}
errors
failedAt
platform
channel {
...ChannelFragment
}
channelId
app {
...AppFragment
}
appId
tags
meta
etag
isMultipleParty
}
backgroundTask {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
type
message
status
data
meta
runAt
endAt
etag
}
}
}
Variables
{"appId": 4}
Response
{
"data": {
"apiViewer": {
"id": "4",
"_id": "4",
"distinctDataSourceData": {},
"fetchDataSourceData": {},
"fetchGeoNearDataSourceData": {},
"memberRaw": {},
"member": Member,
"members": MemberConnection,
"admins": AdminConnection,
"channel": Channel,
"conversationHistory": ChatConnection,
"assignments": AssignmentConnection,
"assignment": Assignment,
"groups": GroupConnection,
"installedIntegrations": [AppIntegration],
"installedIntegration": AppIntegration,
"integrations": {},
"app": App,
"userContext": {},
"channels": ChannelConnection,
"tree": Tree,
"whatsAppFile": WhatsAppFileUrl,
"whatsAppTemplate": WhatsAppMessageTemplateConnection,
"postCommentAnalyticsOverview": PostCommentAnalyticsOverviewConnection,
"nlpAnalyticsOverview": NLPAnalyticsCounterConnection,
"analyticsCustomEventOverviewDateHistogram": AnalyticsCustomEventCounterConnectionTB,
"analyticsCustomEventOverviewTable": AnalyticsCustomEventCounterConnectionRD,
"dailyActiveMemberOverview": DailyActiveMemberOverviewPayload,
"activeMemberCounter": ActiveMemberCounterConnection,
"newMemberCounter": NewMemberCounterConnection,
"actions": ActionConnection,
"audiences": AudienceConnection,
"conditions": ConditionConnection,
"localeGroups": LocaleGroupConnection,
"nodes": NodeObjectConnection,
"priorityGroups": PriorityGroupConnection,
"responses": ResponseConnection,
"subscriptionPushes": SubscriptionPushConnection,
"trees": TreeConnection,
"triggers": TriggerConnection,
"file": RetrieveFilePayload,
"chat": Chat,
"backgroundTask": BackgroundTask
}
}
}
user
Response
Returns a User
Example
Query
query User {
user {
id
_id
createdAt
updatedAt
apps {
appId
app {
...AppFragment
}
acls
default
roles {
...RoleFragment
}
}
partners {
partnerId
partner {
...PartnerFragment
}
acls
default
roles {
...RoleFragment
}
}
firstName
lastName
fullName
profilePic
ownRoles {
id
_id
createdAt
updatedAt
name
acls
app {
...AppFragment
}
system
tags
etag
}
acls
email {
email
emails {
...EmailFragment
}
verified
}
meta
tags
platformCred {
fbUserId
}
sessionMeta
preferences {
recentTrees {
...TreeFragment
}
recentTreeIds
}
etag
stripeProducts
}
}
Response
{
"data": {
"user": {
"id": 4,
"_id": "4",
"createdAt": {},
"updatedAt": {},
"apps": [UserAppConfig],
"partners": [UserPartnerConfig],
"firstName": "xyz789",
"lastName": "abc123",
"fullName": "xyz789",
"profilePic": "abc123",
"ownRoles": [Role],
"acls": ["xyz789"],
"email": EmailCred,
"meta": {},
"tags": ["abc123"],
"platformCred": PlatformCred,
"sessionMeta": {},
"preferences": UserPreferences,
"etag": "4",
"stripeProducts": {}
}
}
}
Mutations
Agenda
createAgenda
Description
A function to create agenda.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "agenda:create"]
Response
Returns a CreateAgendaPayload
Arguments
| Name | Description |
|---|---|
input - CreateAgendaInput! |
Example
Query
mutation CreateAgenda($input: CreateAgendaInput!) {
createAgenda(input: $input) {
agenda {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
member {
...MemberFragment
}
memberId
channel {
...ChannelFragment
}
channelId
responses
tree {
...TreeFragment
}
treeId
node {
...NodeObjectFragment
}
nodeCompositeId
nextRunAt
completed
lastRunAt
pattern
runUntil
type
priority
subscriptionPush {
...AgendaSubscriptionPushConfigFragment
}
tag
meta
etag
}
agendaRaw
clientMutationId
}
}
Variables
{"input": CreateAgendaInput}
Response
{
"data": {
"createAgenda": {
"agenda": Agenda,
"agendaRaw": {},
"clientMutationId": 4
}
}
}
updateAgenda
Description
A function to update agenda.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "agenda:update"]
Response
Returns an UpdateAgendaPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAgendaInput! |
Example
Query
mutation UpdateAgenda($input: UpdateAgendaInput!) {
updateAgenda(input: $input) {
agenda {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
member {
...MemberFragment
}
memberId
channel {
...ChannelFragment
}
channelId
responses
tree {
...TreeFragment
}
treeId
node {
...NodeObjectFragment
}
nodeCompositeId
nextRunAt
completed
lastRunAt
pattern
runUntil
type
priority
subscriptionPush {
...AgendaSubscriptionPushConfigFragment
}
tag
meta
etag
}
clientMutationId
}
}
Variables
{"input": UpdateAgendaInput}
Response
{
"data": {
"updateAgenda": {
"agenda": Agenda,
"clientMutationId": 4
}
}
}
deleteAgenda
Description
A function to delete agenda.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "agenda:delete"]
Response
Returns a DeleteAgendaPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAgendaInput! |
Example
Query
mutation DeleteAgenda($input: DeleteAgendaInput!) {
deleteAgenda(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteAgendaInput}
Response
{
"data": {
"deleteAgenda": {
"clientMutationId": "4"
}
}
}
App Integration
putAppIntegration
Description
A function to put app integration. Currently deprecated.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "integration:create"]
Response
Returns a PutAppIntegrationPayload
Arguments
| Name | Description |
|---|---|
input - PutAppIntegrationInput! |
Example
Query
mutation PutAppIntegration($input: PutAppIntegrationInput!) {
putAppIntegration(input: $input) {
app {
id
_id
createdAt
updatedAt
name
description
inlets {
...ChannelFragment
}
outlets {
...ChannelFragment
}
meta
integrations
activated
teamMembers {
...TeamMemberFragment
}
dataSources {
...DataSourceFragment
}
dataSource {
...DataSourceFragment
}
pairs {
...PairFragment
}
managedBy {
...PartnerFragment
}
managementType
etag
}
appId
ok
err_code
err
integrationId
clientMutationId
}
}
Variables
{"input": PutAppIntegrationInput}
Response
{
"data": {
"putAppIntegration": {
"app": App,
"appId": "4",
"ok": 987,
"err_code": 123,
"err": "abc123",
"integrationId": "4",
"clientMutationId": "4"
}
}
}
updateAppIntegration
Description
A function to update app integration. Currently deprecated.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "integration:update"]
Response
Returns an UpdateAppIntegrationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAppIntegrationInput! |
Example
Query
mutation UpdateAppIntegration($input: UpdateAppIntegrationInput!) {
updateAppIntegration(input: $input) {
app {
id
_id
createdAt
updatedAt
name
description
inlets {
...ChannelFragment
}
outlets {
...ChannelFragment
}
meta
integrations
activated
teamMembers {
...TeamMemberFragment
}
dataSources {
...DataSourceFragment
}
dataSource {
...DataSourceFragment
}
pairs {
...PairFragment
}
managedBy {
...PartnerFragment
}
managementType
etag
}
clientMutationId
}
}
Variables
{"input": UpdateAppIntegrationInput}
Response
{
"data": {
"updateAppIntegration": {
"app": App,
"clientMutationId": 4
}
}
}
updateAppIntegrationMeta
Description
A function to update App Integration Meta.
rate limit
10 call(s) per app per mintue
scope
["api:admin", "appIntegration:update"]
Response
Returns an UpdateAppIntegrationMetaPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAppIntegrationMetaInput! |
Example
Query
mutation UpdateAppIntegrationMeta($input: UpdateAppIntegrationMetaInput!) {
updateAppIntegrationMeta(input: $input) {
appIntegration {
_id
id
app {
...AppFragment
}
appId
description
alias
meta
integration_id
integrationKey
integrationId
features
build
etag
createdAt
updatedAt
signature
secret
channel {
...ChannelFragment
}
integrationName
integrationDescription
latestPublished
isLatestPublished
icon
author {
...AuthorFragment
}
authorId
supportEmail
readme
termsAndConditionsUrl
privacyPolicyUrl
websiteUrl
builderSidebarView {
...IntegrationViewFragment
}
dashboardView {
...IntegrationViewFragment
}
customView {
...IntegrationViewFragment
}
changelog
scopes
endpoints {
...IntegrationEndpointsFragment
}
resourceTemplates {
...ResourceTemplateFragment
}
defaultResourceTemplate {
...ResourceTemplateFragment
}
hooks {
...HookFragment
}
functionString
settingsView
platformSettingsView
settingsSchema
settingsValidatorFunctionString
trees {
...IntegrationTreeFragment
}
supportTicketing
version
inbox {
...InboxIntegrationFragment
}
}
clientMutationId
}
}
Variables
{"input": UpdateAppIntegrationMetaInput}
Response
{
"data": {
"updateAppIntegrationMeta": {
"appIntegration": AppIntegration,
"clientMutationId": "4"
}
}
}
Boradcast
createAudience
Description
A function to create audience.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "audience:create"]
Response
Returns a CreateAudiencePayload
Arguments
| Name | Description |
|---|---|
input - CreateAudienceInput! |
Example
Query
mutation CreateAudience($input: CreateAudienceInput!) {
createAudience(input: $input) {
audience {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
filter {
...AudienceFilterFragment
}
channel {
...ChannelFragment
}
channelId
tags
etag
}
clientMutationId
}
}
Variables
{"input": CreateAudienceInput}
Response
{
"data": {
"createAudience": {
"audience": Audience,
"clientMutationId": 4
}
}
}
createRetryAudience
Description
A function to create retry audience from subscription push.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "audience:create"]
Response
Returns a CreateRetryAudiencePayload
Arguments
| Name | Description |
|---|---|
input - CreateRetryAudienceInput! |
Example
Query
mutation CreateRetryAudience($input: CreateRetryAudienceInput!) {
createRetryAudience(input: $input) {
audiences {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
filter {
...AudienceFilterFragment
}
channel {
...ChannelFragment
}
channelId
tags
etag
}
clientMutationId
}
}
Variables
{"input": CreateRetryAudienceInput}
Response
{
"data": {
"createRetryAudience": {
"audiences": [Audience],
"clientMutationId": "4"
}
}
}
updateAudience
Description
A function to update audience.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "audience:update"]
Response
Returns an UpdateAudiencePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAudienceInput! |
Example
Query
mutation UpdateAudience($input: UpdateAudienceInput!) {
updateAudience(input: $input) {
audience {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
filter {
...AudienceFilterFragment
}
channel {
...ChannelFragment
}
channelId
tags
etag
}
clientMutationId
}
}
Variables
{"input": UpdateAudienceInput}
Response
{
"data": {
"updateAudience": {
"audience": Audience,
"clientMutationId": "4"
}
}
}
deleteAudience
Description
A function to delete audience.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "audience:delete"]
Response
Returns a DeleteAudiencePayload
Arguments
| Name | Description |
|---|---|
input - DeleteAudienceInput! |
Example
Query
mutation DeleteAudience($input: DeleteAudienceInput!) {
deleteAudience(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteAudienceInput}
Response
{
"data": {
"deleteAudience": {
"clientMutationId": "4"
}
}
}
createSubscriptionPush
Description
A function to create subscription push.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "push:create"]
Response
Returns a CreateSubscriptionPushPayload
Arguments
| Name | Description |
|---|---|
input - CreateSubscriptionPushInput! |
Example
Query
mutation CreateSubscriptionPush($input: CreateSubscriptionPushInput!) {
createSubscriptionPush(input: $input) {
subscriptionPush {
id
_id
createdAt
updatedAt
name
description
messages
messagesHydrated {
...MessageFragment
}
app {
...AppFragment
}
appId
sent
sentCount
read
readCount
interacted
interactedCount
tags
agendaMeta
fbMessageTag
fbOTNTags
errors {
...SubscriptionPushErrorFragment
}
errorStats {
...SubscriptionPushErrorStatsFragment
}
includeAudiences {
...AudienceFragment
}
excludeAudiences {
...AudienceFragment
}
filter {
...AudienceFilterFragment
}
memberIds
memberCount
members {
...MemberConnectionFragment
}
scheduleAt
sentStart
sentEnd
agendas {
...AgendaFragment
}
priority
parentSubscriptionPush {
...SubscriptionPushFragment
}
parentSubscriptionPushId
childSubscriptionPushes {
...SubscriptionPushFragment
}
childSubscriptionPushIds
etag
}
clientMutationId
}
}
Variables
{"input": CreateSubscriptionPushInput}
Response
{
"data": {
"createSubscriptionPush": {
"subscriptionPush": SubscriptionPush,
"clientMutationId": "4"
}
}
}
updateSubscriptionPush
Description
A function to create subscription push.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "push:update"]
Response
Returns an UpdateSubscriptionPushPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSubscriptionPushInput! |
Example
Query
mutation UpdateSubscriptionPush($input: UpdateSubscriptionPushInput!) {
updateSubscriptionPush(input: $input) {
subscriptionPush {
id
_id
createdAt
updatedAt
name
description
messages
messagesHydrated {
...MessageFragment
}
app {
...AppFragment
}
appId
sent
sentCount
read
readCount
interacted
interactedCount
tags
agendaMeta
fbMessageTag
fbOTNTags
errors {
...SubscriptionPushErrorFragment
}
errorStats {
...SubscriptionPushErrorStatsFragment
}
includeAudiences {
...AudienceFragment
}
excludeAudiences {
...AudienceFragment
}
filter {
...AudienceFilterFragment
}
memberIds
memberCount
members {
...MemberConnectionFragment
}
scheduleAt
sentStart
sentEnd
agendas {
...AgendaFragment
}
priority
parentSubscriptionPush {
...SubscriptionPushFragment
}
parentSubscriptionPushId
childSubscriptionPushes {
...SubscriptionPushFragment
}
childSubscriptionPushIds
etag
}
clientMutationId
}
}
Variables
{"input": UpdateSubscriptionPushInput}
Response
{
"data": {
"updateSubscriptionPush": {
"subscriptionPush": SubscriptionPush,
"clientMutationId": "4"
}
}
}
deleteSubscriptionPush
Description
A function to create subscription push.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "push:delete"]
Response
Returns a DeleteSubscriptionPushPayload
Arguments
| Name | Description |
|---|---|
input - DeleteSubscriptionPushInput! |
Example
Query
mutation DeleteSubscriptionPush($input: DeleteSubscriptionPushInput!) {
deleteSubscriptionPush(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteSubscriptionPushInput}
Response
{
"data": {
"deleteSubscriptionPush": {
"clientMutationId": "4"
}
}
}
Channel
createChannel
Description
A function to create channel.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "channel:createChannel"]
Response
Returns a CreateChannelPayload
Arguments
| Name | Description |
|---|---|
input - CreateChannelInput! |
Example
Query
mutation CreateChannel($input: CreateChannelInput!) {
createChannel(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": CreateChannelInput}
Response
{
"data": {
"createChannel": {
"channel": Channel,
"error": GenericError,
"clientMutationId": 4
}
}
}
updateChannel
Description
A function to update channel.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "channel:updateAvailabilities", "channel:updateBasicInfo"]
Input params scope
"on"
scope: ["api:admin", "channel:updateAvailabilities"]
"name"
scope: ["api:admin", "channel:updateBasicInfo"]
"description"
scope: ["api:admin", "channel:updateBasicInfo"]
"tags"
scope: ["api:admin", "channel:updateBasicInfo"]
"meta"
scope: ["api:admin", "channel:updateBasicInfo"]
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelInput! |
Example
Query
mutation UpdateChannel($input: UpdateChannelInput!) {
updateChannel(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": UpdateChannelInput}
Response
{
"data": {
"updateChannel": {
"channel": Channel,
"error": GenericError,
"clientMutationId": 4
}
}
}
deleteChannel
Description
A function to delete a channel.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "channel:deleteChannel"]
Response
Returns a DeleteChannelPayload
Arguments
| Name | Description |
|---|---|
input - DeleteChannelInput! |
Example
Query
mutation DeleteChannel($input: DeleteChannelInput!) {
deleteChannel(input: $input) {
error {
name
code
message
}
forceRequest
errorMessage
errors {
name
code
message
meta
}
clientMutationId
}
}
Variables
{"input": DeleteChannelInput}
Response
{
"data": {
"deleteChannel": {
"error": GenericError,
"forceRequest": true,
"errorMessage": "abc123",
"errors": [endpointError],
"clientMutationId": 4
}
}
}
unsubscribeChannel
Description
A function to unsubscribe a channel.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "channel:Unsubscribe"]
Response
Returns an UnsubscribeChannelPayload
Arguments
| Name | Description |
|---|---|
input - UnsubscribeChannelInput! |
Example
Query
mutation UnsubscribeChannel($input: UnsubscribeChannelInput!) {
unsubscribeChannel(input: $input) {
error {
name
code
message
}
forceRequest
errorMessage
errors {
name
code
message
meta
}
clientMutationId
}
}
Variables
{"input": UnsubscribeChannelInput}
Response
{
"data": {
"unsubscribeChannel": {
"error": GenericError,
"forceRequest": true,
"errorMessage": "xyz789",
"errors": [endpointError],
"clientMutationId": "4"
}
}
}
subscribeChannel
Description
A function to subscribe channel from platform integration
rate limit
10 call(s) per app per mintue
scope
["api:admin", "channel:updatePlatformInfo"]
Response
Returns a SubscribeChannelPayload
Arguments
| Name | Description |
|---|---|
input - SubscribeChannelInput! |
Example
Query
mutation SubscribeChannel($input: SubscribeChannelInput!) {
subscribeChannel(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": SubscribeChannelInput}
Response
{
"data": {
"subscribeChannel": {
"channel": Channel,
"error": GenericError,
"clientMutationId": "4"
}
}
}
updateChannelEnvironment
Description
A function to update channel environment.
rate limit
60 call(s) per app per mintue
scope
["api:admin", "channel:updateTreeSettings", "channel:updateBasicInfo", "channel:updateAvailabilities", "channel:updateDetail"]
Input params scope
"on"
scope: ["api:admin", "channel:updateAvailabilities"]
"availability"
scope: ["api:admin", "channel:updateAvailabilities"]
"name"
scope: ["api:admin", "channel:updateBasicInfo"]
"hooks"
scope: ["api:admin", "channel:updateDetail"]
"webhooks"
scope: ["api:admin", "channel:updateDetail"]
"treeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"globalNodeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"offTreeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"offGlobalNodeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"livechatTreeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"livechatGlobalNodeIds"
scope: ["api:admin", "channel:updateTreeSettings"]
"coreVersion"
scope: ["api:admin", "channel:updateTreeSettings"]
"meta"
scope: ["api:admin", "channel:updateTreeSettings"]
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentInput! |
Example
Query
mutation UpdateChannelEnvironment($input: UpdateChannelEnvironmentInput!) {
updateChannelEnvironment(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": UpdateChannelEnvironmentInput}
Response
{
"data": {
"updateChannelEnvironment": {
"channel": Channel,
"error": GenericError,
"clientMutationId": 4
}
}
}
updateChannelEnvironmentHooks
Description
A function to update channel environment hooks.
rate limit
60 call(s) per app per mintue
scope
["api:admin", "channel:updateDetail"]
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentHooksInput! |
Example
Query
mutation UpdateChannelEnvironmentHooks($input: UpdateChannelEnvironmentHooksInput!) {
updateChannelEnvironmentHooks(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": UpdateChannelEnvironmentHooksInput}
Response
{
"data": {
"updateChannelEnvironmentHooks": {
"channel": Channel,
"error": GenericError,
"clientMutationId": "4"
}
}
}
updateChannelEnvironmentWebhooks
Description
A function to update channel environment webhooks.
rate limit
60 call(s) per app per mintue
scope
["api:admin", "channel:updateDetail"]
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentWebhooksInput! |
Example
Query
mutation UpdateChannelEnvironmentWebhooks($input: UpdateChannelEnvironmentWebhooksInput!) {
updateChannelEnvironmentWebhooks(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": UpdateChannelEnvironmentWebhooksInput}
Response
{
"data": {
"updateChannelEnvironmentWebhooks": {
"channel": Channel,
"error": GenericError,
"clientMutationId": "4"
}
}
}
updateChannelEnvironmentTreeGlobalNode
Description
A function to update channel environment trees and global nodes.
rate limit
60 call(s) per app per mintue
scope
["api:admin", "channel:updateTreeSettings"]
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentTreeGlobalNodeInput! |
Example
Query
mutation UpdateChannelEnvironmentTreeGlobalNode($input: UpdateChannelEnvironmentTreeGlobalNodeInput!) {
updateChannelEnvironmentTreeGlobalNode(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": UpdateChannelEnvironmentTreeGlobalNodeInput}
Response
{
"data": {
"updateChannelEnvironmentTreeGlobalNode": {
"channel": Channel,
"error": GenericError,
"clientMutationId": "4"
}
}
}
updateChannelEnvironmentOffTreeGlobalNode
Description
A function to update channel environment off trees and global nodes.
rate limit
60 call(s) per app per mintue
scope
["api:admin", "channel:updateTreeSettings"]
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentOffTreeGlobalNodeInput! |
Example
Query
mutation UpdateChannelEnvironmentOffTreeGlobalNode($input: UpdateChannelEnvironmentOffTreeGlobalNodeInput!) {
updateChannelEnvironmentOffTreeGlobalNode(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": UpdateChannelEnvironmentOffTreeGlobalNodeInput}
Response
{
"data": {
"updateChannelEnvironmentOffTreeGlobalNode": {
"channel": Channel,
"error": GenericError,
"clientMutationId": 4
}
}
}
updateChannelEnvironmentLivechatTreeGlobalNode
Description
A function to update channel environment livechat trees and global nodes.
rate limit
60 call(s) per app per mintue
scope
["api:admin", "channel:updateTreeSettings"]
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelEnvironmentLivechatTreeGlobalNodeInput! |
Example
Query
mutation UpdateChannelEnvironmentLivechatTreeGlobalNode($input: UpdateChannelEnvironmentLivechatTreeGlobalNodeInput!) {
updateChannelEnvironmentLivechatTreeGlobalNode(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{
"input": UpdateChannelEnvironmentLivechatTreeGlobalNodeInput
}
Response
{
"data": {
"updateChannelEnvironmentLivechatTreeGlobalNode": {
"channel": Channel,
"error": GenericError,
"clientMutationId": 4
}
}
}
createChannelEnvironment
Description
A function to create a new channel environment.
rate limit
60 call(s) per app per mintue
scope
["api:admin", "channel:createEnvironment"]
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - CreateChannelEnvironmentInput! |
Example
Query
mutation CreateChannelEnvironment($input: CreateChannelEnvironmentInput!) {
createChannelEnvironment(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": CreateChannelEnvironmentInput}
Response
{
"data": {
"createChannelEnvironment": {
"channel": Channel,
"error": GenericError,
"clientMutationId": "4"
}
}
}
deleteChannelEnvironment
Description
A function to delete a new channel environment.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "channel:deleteEnvironment"]
Response
Returns a DeleteChannelEnvironmentPayload
Arguments
| Name | Description |
|---|---|
input - DeleteChannelEnvironmentInput! |
Example
Query
mutation DeleteChannelEnvironment($input: DeleteChannelEnvironmentInput!) {
deleteChannelEnvironment(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
forceRequest
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": DeleteChannelEnvironmentInput}
Response
{
"data": {
"deleteChannelEnvironment": {
"channel": Channel,
"forceRequest": true,
"error": GenericError,
"clientMutationId": 4
}
}
}
updateChannelIncomingWebhooks
Description
rate limit 5 call(s) per app per mintue
scope
["api:admin", "channel:updateDetail"]
Response
Returns an UpdateChannelIncomingWebhookPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelIncomingWebhookInput! |
Example
Query
mutation UpdateChannelIncomingWebhooks($input: UpdateChannelIncomingWebhookInput!) {
updateChannelIncomingWebhooks(input: $input) {
channel {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
type
relayWebhooks
webhooks
verificationToken
channelSecret
info
broadcastGroups {
...ChannelBroadcastGroupFragment
}
meta
trees {
...TreeFragment
}
globalNodes {
...NodeObjectFragment
}
priorityGroups {
...ChannelPriorityGroupFragment
}
tags
inletGroup
etag
on
sendOutletMessageViaBot
livechatAgendas
liveChatAgendaObjects {
...LiveChatAgendaFragment
}
availability
exclusiveLiveChat
locked
wabaStatus
wabaError
wabaInfo
wabaIntegration {
...WABAIntegrationFragment
}
environment {
...ChannelEnvironmentFragment
}
environments {
...ChannelEnvironmentFragment
}
incomingWebhooks {
...ChannelIncomingWebhookFragment
}
archived
archivedAt
connected
}
clientMutationId
}
}
Variables
{"input": UpdateChannelIncomingWebhookInput}
Response
{
"data": {
"updateChannelIncomingWebhooks": {
"channel": Channel,
"clientMutationId": 4
}
}
}
Priority Group
createPriorityGroup
Description
A function to create priority group.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "priorityGroup:create"]
Response
Returns a CreatePriorityGroupPayload
Arguments
| Name | Description |
|---|---|
input - CreatePriorityGroupInput! |
Example
Query
mutation CreatePriorityGroup($input: CreatePriorityGroupInput!) {
createPriorityGroup(input: $input) {
priorityGroup {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
channel {
...ChannelFragment
}
members {
...MemberFragment
}
memberIds
tags
etag
}
clientMutationId
}
}
Variables
{"input": CreatePriorityGroupInput}
Response
{
"data": {
"createPriorityGroup": {
"priorityGroup": PriorityGroup,
"clientMutationId": 4
}
}
}
updatePriorityGroup
Description
A function to update priority group.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "priorityGroup:update"]
Response
Returns an UpdatePriorityGroupPayload
Arguments
| Name | Description |
|---|---|
input - UpdatePriorityGroupInput! |
Example
Query
mutation UpdatePriorityGroup($input: UpdatePriorityGroupInput!) {
updatePriorityGroup(input: $input) {
priorityGroup {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
channel {
...ChannelFragment
}
members {
...MemberFragment
}
memberIds
tags
etag
}
clientMutationId
}
}
Variables
{"input": UpdatePriorityGroupInput}
Response
{
"data": {
"updatePriorityGroup": {
"priorityGroup": PriorityGroup,
"clientMutationId": "4"
}
}
}
deletePriorityGroup
Description
A function to delete priority group.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "priorityGroup:delete"]
Response
Returns a DeletePriorityGroupPayload
Arguments
| Name | Description |
|---|---|
input - DeletePriorityGroupInput! |
Example
Query
mutation DeletePriorityGroup($input: DeletePriorityGroupInput!) {
deletePriorityGroup(input: $input) {
clientMutationId
}
}
Variables
{"input": DeletePriorityGroupInput}
Response
{"data": {"deletePriorityGroup": {"clientMutationId": 4}}}
Data Source
createDataSourceDoc
Description
A function to create datasource document.
rate limit
30 call(s) per app per mintue
scope
["api:admin", "datasource:api", "dataSource:createDoc"]
Response
Returns a CreateDataSourceDocPayload
Arguments
| Name | Description |
|---|---|
input - CreateDataSourceDocInput! |
Example
Query
mutation CreateDataSourceDoc($input: CreateDataSourceDocInput!) {
createDataSourceDoc(input: $input) {
clientMutationId
data
}
}
Variables
{"input": CreateDataSourceDocInput}
Response
{"data": {"createDataSourceDoc": {"clientMutationId": 4, "data": {}}}}
updateDataSourceDoc
Description
A function to update datasource document (replace) by _id.
rate limit
30 call(s) per app per mintue
scope
["api:admin", "datasource:api", "dataSource:updateDoc"]
Response
Returns an UpdateDataSourceDocPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDataSourceDocInput! |
Example
Query
mutation UpdateDataSourceDoc($input: UpdateDataSourceDocInput!) {
updateDataSourceDoc(input: $input) {
clientMutationId
data
}
}
Variables
{"input": UpdateDataSourceDocInput}
Response
{"data": {"updateDataSourceDoc": {"clientMutationId": 4, "data": {}}}}
deleteDataSourceDocs
Description
A function to delete datasource documents by _id.
rate limit
30 call(s) per app per mintue
scope
["api:admin", "datasource:api", "dataSource:deleteDoc"]
Response
Returns a DeleteDataSourceDocsPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDataSourceDocsInput! |
Example
Query
mutation DeleteDataSourceDocs($input: DeleteDataSourceDocsInput!) {
deleteDataSourceDocs(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteDataSourceDocsInput}
Response
{"data": {"deleteDataSourceDocs": {"clientMutationId": 4}}}
importDataSource
Description
A function to import datasource documents.
rate limit
30 call(s) per app per mintue
scope
["api:admin", "datasource:api", "dataSource:importDatasource"]
Response
Returns an ImportDataSourcePayload
Arguments
| Name | Description |
|---|---|
input - ImportDataSourceInput! |
Example
Query
mutation ImportDataSource($input: ImportDataSourceInput!) {
importDataSource(input: $input) {
clientMutationId
data
}
}
Variables
{"input": ImportDataSourceInput}
Response
{
"data": {
"importDataSource": {
"clientMutationId": "4",
"data": {}
}
}
}
createDataSource
Description
A function to create datasource.
rate limit
20 call(s) per app per mintue
scope
["api:admin", "datasource:api", "dataSource:createDatasource"]
Response
Returns a CreateDataSourcePayload
Arguments
| Name | Description |
|---|---|
input - CreateDataSourceInput! |
Example
Query
mutation CreateDataSource($input: CreateDataSourceInput!) {
createDataSource(input: $input) {
dataSource {
name
description
collectionName
shopifyIntegration
data {
...DataSourceConnectionFragment
}
dataByQuery
}
clientMutationId
}
}
Variables
{"input": CreateDataSourceInput}
Response
{
"data": {
"createDataSource": {
"dataSource": DataSource,
"clientMutationId": "4"
}
}
}
updateDataSource
Description
A function to update datasource.
rate limit
20 call(s) per app per mintue
scope
["api:admin", "datasource:api", "dataSource:updateDatasource"]
Response
Returns an UpdateDataSourcePayload
Arguments
| Name | Description |
|---|---|
input - UpdateDataSourceInput! |
Example
Query
mutation UpdateDataSource($input: UpdateDataSourceInput!) {
updateDataSource(input: $input) {
dataSource {
name
description
collectionName
shopifyIntegration
data {
...DataSourceConnectionFragment
}
dataByQuery
}
clientMutationId
}
}
Variables
{"input": UpdateDataSourceInput}
Response
{
"data": {
"updateDataSource": {
"dataSource": DataSource,
"clientMutationId": "4"
}
}
}
deleteDataSource
Description
A function to delete datasource.
rate limit
20 call(s) per app per mintue
scope
["api:admin", "datasource:api", "dataSource:deleteDatasource"]
Response
Returns a DeleteDataSourcePayload
Arguments
| Name | Description |
|---|---|
input - DeleteDataSourceInput! |
Example
Query
mutation DeleteDataSource($input: DeleteDataSourceInput!) {
deleteDataSource(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteDataSourceInput}
Response
{"data": {"deleteDataSource": {"clientMutationId": 4}}}
upsertDataSourceDocs
Description
A function to upsert datasource document.
rate limit
30 call(s) per app per mintue
scope
["api:admin", "datasource:api", "dataSource:createDoc", "dateSource:updateDoc"]
Response
Returns an UpsertDataSourceDocsPayload
Arguments
| Name | Description |
|---|---|
input - UpsertDataSourceDocsInput! |
Example
Query
mutation UpsertDataSourceDocs($input: UpsertDataSourceDocsInput!) {
upsertDataSourceDocs(input: $input) {
result
clientMutationId
}
}
Variables
{"input": UpsertDataSourceDocsInput}
Response
{
"data": {
"upsertDataSourceDocs": {
"result": {},
"clientMutationId": "4"
}
}
}
updateDataSourceDocs
Description
A function to update datasource document.
rate limit
30 call(s) per app per mintue
scope
["api:admin", "datasource:api", "dateSource:updateDoc"]
Response
Returns an UpdateDataSourceDocsPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDataSourceDocsInput! |
Example
Query
mutation UpdateDataSourceDocs($input: UpdateDataSourceDocsInput!) {
updateDataSourceDocs(input: $input) {
result
clientMutationId
}
}
Variables
{"input": UpdateDataSourceDocsInput}
Response
{
"data": {
"updateDataSourceDocs": {
"result": {},
"clientMutationId": "4"
}
}
}
findAndModifyDataSourceDoc
Description
A function to find and modify datasource document.
Format: https://docs.mongodb.com/manual/reference/method/db.collection.findAndModify/
rate limit
30 call(s) per app per mintue
scope
["api:admin", "datasource:api", "dateSource:updateDoc"]
Response
Returns a FindAndModifyDataSourceDocPayload
Arguments
| Name | Description |
|---|---|
input - FindAndModifyDataSourceDocInput! |
Example
Query
mutation FindAndModifyDataSourceDoc($input: FindAndModifyDataSourceDocInput!) {
findAndModifyDataSourceDoc(input: $input) {
result
clientMutationId
}
}
Variables
{"input": FindAndModifyDataSourceDocInput}
Response
{
"data": {
"findAndModifyDataSourceDoc": {
"result": {},
"clientMutationId": "4"
}
}
}
aggregateDataSourceDocs
Description
A function to aggregate datasource documents.
Format: https://docs.mongodb.com/manual/core/aggregation-pipeline/
rate limit
30 call(s) per app per mintue
scope
["api:admin", "datasource:api"]
Response
Returns an AggregateDataSourceDocsPayload
Arguments
| Name | Description |
|---|---|
input - AggregateDataSourceDocsInput! |
Example
Query
mutation AggregateDataSourceDocs($input: AggregateDataSourceDocsInput!) {
aggregateDataSourceDocs(input: $input) {
result
clientMutationId
}
}
Variables
{"input": AggregateDataSourceDocsInput}
Response
{"data": {"aggregateDataSourceDocs": {"result": {}, "clientMutationId": 4}}}
Locale Group
createLocaleGroup
Description
A function to create locale group.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "localeGroup:create"]
Response
Returns a CreateLocaleGroupPayload
Arguments
| Name | Description |
|---|---|
input - CreateLocaleGroupInput! |
Example
Query
mutation CreateLocaleGroup($input: CreateLocaleGroupInput!) {
createLocaleGroup(input: $input) {
localeGroup {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
locales
name
etag
}
clientMutationId
}
}
Variables
{"input": CreateLocaleGroupInput}
Response
{
"data": {
"createLocaleGroup": {
"localeGroup": LocaleGroup,
"clientMutationId": "4"
}
}
}
updateLocaleGroup
Description
A function to update locale group.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "localeGroup:update"]
Response
Returns an UpdateLocaleGroupPayload
Arguments
| Name | Description |
|---|---|
input - UpdateLocaleGroupInput! |
Example
Query
mutation UpdateLocaleGroup($input: UpdateLocaleGroupInput!) {
updateLocaleGroup(input: $input) {
localeGroup {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
locales
name
etag
}
clientMutationId
}
}
Variables
{"input": UpdateLocaleGroupInput}
Response
{
"data": {
"updateLocaleGroup": {
"localeGroup": LocaleGroup,
"clientMutationId": 4
}
}
}
deleteLocaleGroup
Description
A function to delete locale group.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "localeGroup:delete"]
Response
Returns a DeleteLocaleGroupPayload
Arguments
| Name | Description |
|---|---|
input - DeleteLocaleGroupInput! |
Example
Query
mutation DeleteLocaleGroup($input: DeleteLocaleGroupInput!) {
deleteLocaleGroup(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteLocaleGroupInput}
Response
{"data": {"deleteLocaleGroup": {"clientMutationId": 4}}}
Media Library
Members
createMember
Description
A function to create member.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "member:create"]
Response
Returns a CreateMemberPayload
Arguments
| Name | Description |
|---|---|
input - CreateMemberInput! |
Example
Query
mutation CreateMember($input: CreateMemberInput!) {
createMember(input: $input) {
member {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
channel {
...ChannelFragment
}
channelId
platform
profile {
...MemberProfileFragment
}
inboxProfile {
...InboxMemberProfileFragment
}
tags
meta
botMeta {
...BotMetaFragment
}
externalId
botId
admin {
...AdminFragment
}
adminId
group {
...GroupFragment
}
assignment
fbId
name
firstName
lastName
profilePic
gender
customLocale
locale
email
profilePicString
inletGroup
fbOTNTokens {
...FbOTNTokenFragment
}
notes {
...NoteFragment
}
etag
}
clientMutationId
}
}
Variables
{"input": CreateMemberInput}
Response
{
"data": {
"createMember": {
"member": Member,
"clientMutationId": "4"
}
}
}
updateMember
Description
A function to update member.
rate limit
10 call(s) per app per mintue
scope
["api:admin", "member:update", "member:updateProfile", "member:updateBotMeta", "member:updateMeta"]
Input params scope
"profile"
scope: ["api:admin", "member:update", "member:updateProfile"]
"tags"
scope: ["api:admin", "member:update", "member:updateProfile"]
"meta"
scope: ["api:admin", "member:update", "member:updateMeta"]
"botMeta"
scope: ["api:admin", "member:update", "member:updateBotMeta"]
"admin"
scope: ["api:admin", "member:update"]
"group"
scope: ["api:admin", "member:update"]
"firstName"
scope: ["api:admin", "member:update", "member:updateProfile"]
"lastName"
scope: ["api:admin", "member:update", "member:updateProfile"]
"profilePic"
scope: ["api:admin", "member:update", "member:updateProfile"]
"gender"
scope: ["api:admin", "member:update", "member:updateProfile"]
"locale"
scope: ["api:admin", "member:update", "member:updateProfile"]
"email"
scope: ["api:admin", "member:update", "member:updateProfile"]
"profilePicString"
scope: ["api:admin", "member:update", "member:updateProfile"]
Response
Returns an UpdateMemberPayload
Arguments
| Name | Description |
|---|---|
input - UpdateMemberInput! |
Example
Query
mutation UpdateMember($input: UpdateMemberInput!) {
updateMember(input: $input) {
member {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
channel {
...ChannelFragment
}
channelId
platform
profile {
...MemberProfileFragment
}
inboxProfile {
...InboxMemberProfileFragment
}
tags
meta
botMeta {
...BotMetaFragment
}
externalId
botId
admin {
...AdminFragment
}
adminId
group {
...GroupFragment
}
assignment
fbId
name
firstName
lastName
profilePic
gender
customLocale
locale
email
profilePicString
inletGroup
fbOTNTokens {
...FbOTNTokenFragment
}
notes {
...NoteFragment
}
etag
}
memberRaw
clientMutationId
}
}
Variables
{"input": UpdateMemberInput}
Response
{
"data": {
"updateMember": {
"member": Member,
"memberRaw": {},
"clientMutationId": 4
}
}
}
deleteMember
Description
A function to permanently delete a member. The conversation history of this member will also be deleted.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "member:delete"]
Response
Returns a DeleteMemberPayload
Arguments
| Name | Description |
|---|---|
input - DeleteMemberInput! |
Example
Query
mutation DeleteMember($input: DeleteMemberInput!) {
deleteMember(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteMemberInput}
Response
{"data": {"deleteMember": {"clientMutationId": 4}}}
deleteMembers
Description
A function to permanently delete members in batch with time filter. The conversation history of these members will also be deleted. NOTE: if no criteria / createdAtFrom / createdAtTo / updatedAtFrom / updatedAtTo is specified, ALL members of the app will be deleted.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "member:delete"]
Response
Returns a DeleteMembersPayload
Arguments
| Name | Description |
|---|---|
input - DeleteMembersInput! |
Example
Query
mutation DeleteMembers($input: DeleteMembersInput!) {
deleteMembers(input: $input) {
backgroundTask {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
type
message
status
data
meta
runAt
endAt
etag
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": DeleteMembersInput}
Response
{
"data": {
"deleteMembers": {
"backgroundTask": BackgroundTask,
"error": GenericError,
"clientMutationId": 4
}
}
}
updateMembers
Description
A function to update members.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "member:update"]
Response
Returns an UpdateMembersPayload
Arguments
| Name | Description |
|---|---|
input - UpdateMembersInput! |
Example
Query
mutation UpdateMembers($input: UpdateMembersInput!) {
updateMembers(input: $input) {
result
clientMutationId
}
}
Variables
{"input": UpdateMembersInput}
Response
{
"data": {
"updateMembers": {
"result": {},
"clientMutationId": "4"
}
}
}
mergeMembersByExternalIds
Description
A function to merge members using two externalIds.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "member:merge"]
Response
Returns a MergeMembersByExternalIdsPayload
Arguments
| Name | Description |
|---|---|
input - MergeMembersByExternalIdsInput! |
Example
Query
mutation MergeMembersByExternalIds($input: MergeMembersByExternalIdsInput!) {
mergeMembersByExternalIds(input: $input) {
member {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
channel {
...ChannelFragment
}
channelId
platform
profile {
...MemberProfileFragment
}
inboxProfile {
...InboxMemberProfileFragment
}
tags
meta
botMeta {
...BotMetaFragment
}
externalId
botId
admin {
...AdminFragment
}
adminId
group {
...GroupFragment
}
assignment
fbId
name
firstName
lastName
profilePic
gender
customLocale
locale
email
profilePicString
inletGroup
fbOTNTokens {
...FbOTNTokenFragment
}
notes {
...NoteFragment
}
etag
}
action
clientMutationId
}
}
Variables
{"input": MergeMembersByExternalIdsInput}
Response
{
"data": {
"mergeMembersByExternalIds": {
"member": Member,
"action": "xyz789",
"clientMutationId": 4
}
}
}
exportChats
Description
A function to export chat history (max return 1000 rows).
rate limit
5 call(s) per app per mintue
scope
["api:admin", "conversation:read"]
Response
Returns an ExportChatsPayload
Arguments
| Name | Description |
|---|---|
input - ExportChatsInput! |
Example
Query
mutation ExportChats($input: ExportChatsInput!) {
exportChats(input: $input) {
url
urls
}
}
Variables
{"input": ExportChatsInput}
Response
{
"data": {
"exportChats": {
"url": "abc123",
"urls": ["abc123"]
}
}
}
importMembers
Description
A function to import member.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "member:import"]
Response
Returns an ImportMembersPayload
Arguments
| Name | Description |
|---|---|
input - ImportMembersInput! |
Example
Query
mutation ImportMembers($input: ImportMembersInput!) {
importMembers(input: $input) {
clientMutationId
backgroundTask {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
type
message
status
data
meta
runAt
endAt
etag
}
}
}
Variables
{"input": ImportMembersInput}
Response
{
"data": {
"importMembers": {
"clientMutationId": 4,
"backgroundTask": BackgroundTask
}
}
}
toggleLiveChat
Description
A function to toggle member live chat state.
rate limit
60 call(s) per app per mintue
scope
["api:admin", "member:updateDetails", "member:ToggleLiveChat"]
Response
Returns a toggleLiveChatPayload
Arguments
| Name | Description |
|---|---|
input - toggleLiveChatInput! |
Example
Query
mutation ToggleLiveChat($input: toggleLiveChatInput!) {
toggleLiveChat(input: $input) {
ok
err_code
err
memberId
member {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
channel {
...ChannelFragment
}
channelId
platform
profile {
...MemberProfileFragment
}
inboxProfile {
...InboxMemberProfileFragment
}
tags
meta
botMeta {
...BotMetaFragment
}
externalId
botId
admin {
...AdminFragment
}
adminId
group {
...GroupFragment
}
assignment
fbId
name
firstName
lastName
profilePic
gender
customLocale
locale
email
profilePicString
inletGroup
fbOTNTokens {
...FbOTNTokenFragment
}
notes {
...NoteFragment
}
etag
}
clientMutationId
}
}
Variables
{"input": toggleLiveChatInput}
Response
{
"data": {
"toggleLiveChat": {
"ok": 987,
"err_code": 987,
"err": "xyz789",
"memberId": 4,
"member": Member,
"clientMutationId": "4"
}
}
}
addMemberTags
Description
A function to add tags to member.
rate limit
10 call(s) per app per mintue
scope
["api:admin", "member:updateDetails", "member:write"]
Response
Returns a ModifyMemberTagsPayload
Arguments
| Name | Description |
|---|---|
input - ModifyMemberTagsInput! |
Example
Query
mutation AddMemberTags($input: ModifyMemberTagsInput!) {
addMemberTags(input: $input) {
ok
err_code
err
memberId
member {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
channel {
...ChannelFragment
}
channelId
platform
profile {
...MemberProfileFragment
}
inboxProfile {
...InboxMemberProfileFragment
}
tags
meta
botMeta {
...BotMetaFragment
}
externalId
botId
admin {
...AdminFragment
}
adminId
group {
...GroupFragment
}
assignment
fbId
name
firstName
lastName
profilePic
gender
customLocale
locale
email
profilePicString
inletGroup
fbOTNTokens {
...FbOTNTokenFragment
}
notes {
...NoteFragment
}
etag
}
clientMutationId
}
}
Variables
{"input": ModifyMemberTagsInput}
Response
{
"data": {
"addMemberTags": {
"ok": 987,
"err_code": 987,
"err": "abc123",
"memberId": 4,
"member": Member,
"clientMutationId": "4"
}
}
}
removeMemberTags
Description
A function to remove tags to member.
rate limit
10 call(s) per app per mintue
scope
["api:admin", "member:updateDetails", "member:write"]
Response
Returns a ModifyMemberTagsPayload
Arguments
| Name | Description |
|---|---|
input - ModifyMemberTagsInput! |
Example
Query
mutation RemoveMemberTags($input: ModifyMemberTagsInput!) {
removeMemberTags(input: $input) {
ok
err_code
err
memberId
member {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
channel {
...ChannelFragment
}
channelId
platform
profile {
...MemberProfileFragment
}
inboxProfile {
...InboxMemberProfileFragment
}
tags
meta
botMeta {
...BotMetaFragment
}
externalId
botId
admin {
...AdminFragment
}
adminId
group {
...GroupFragment
}
assignment
fbId
name
firstName
lastName
profilePic
gender
customLocale
locale
email
profilePicString
inletGroup
fbOTNTokens {
...FbOTNTokenFragment
}
notes {
...NoteFragment
}
etag
}
clientMutationId
}
}
Variables
{"input": ModifyMemberTagsInput}
Response
{
"data": {
"removeMemberTags": {
"ok": 123,
"err_code": 123,
"err": "xyz789",
"memberId": 4,
"member": Member,
"clientMutationId": 4
}
}
}
batchUpdateMember
Description
A function to batch update member.
rate limit
10 call(s) per app per mintue
Array Size Limit max
Input params array size limit
"memberIds"
max: 100
"externalIds"
max: 100
"tags"
max: 10
scope
["api:admin", "member:update", "member:updateProfile"]
Input params scope
"tags"
scope: ["api:admin", "member:update", "member:updateProfile"]
"locale"
scope: ["api:admin", "member:update", "member:updateProfile"]
"gender"
scope: ["api:admin", "member:update", "member:updateProfile"]
Response
Returns a BatchUpdateMemberPayload
Arguments
| Name | Description |
|---|---|
input - BatchUpdateMemberInput! |
Example
Query
mutation BatchUpdateMember($input: BatchUpdateMemberInput!) {
batchUpdateMember(input: $input) {
clientMutationId
}
}
Variables
{"input": BatchUpdateMemberInput}
Response
{
"data": {
"batchUpdateMember": {
"clientMutationId": "4"
}
}
}
batchCreateChat
Description
A function to batch update member.
Array Size Limit max
Input params array size limit
"chats"
max: 80
scope
["api:admin", "chat:create"]
Response
Returns a BatchCreateChatPayload
Arguments
| Name | Description |
|---|---|
input - BatchCreateChatInput! |
Example
Query
mutation BatchCreateChat($input: BatchCreateChatInput!) {
batchCreateChat(input: $input) {
chatIds
clientMutationId
}
}
Variables
{"input": BatchCreateChatInput}
Response
{"data": {"batchCreateChat": {"chatIds": [4], "clientMutationId": 4}}}
addNoteToMember
Description
rate limit 60 call(s) per app per mintue
scope
["api:admin", "member:manageNote"]
Input params scope
"note"
scope: ["api:admin", "note:create"]
Response
Returns an AddNoteToMemberPayload
Arguments
| Name | Description |
|---|---|
input - AddNoteToMemberInput! |
Example
Query
mutation AddNoteToMember($input: AddNoteToMemberInput!) {
addNoteToMember(input: $input) {
member {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
channel {
...ChannelFragment
}
channelId
platform
profile {
...MemberProfileFragment
}
inboxProfile {
...InboxMemberProfileFragment
}
tags
meta
botMeta {
...BotMetaFragment
}
externalId
botId
admin {
...AdminFragment
}
adminId
group {
...GroupFragment
}
assignment
fbId
name
firstName
lastName
profilePic
gender
customLocale
locale
email
profilePicString
inletGroup
fbOTNTokens {
...FbOTNTokenFragment
}
notes {
...NoteFragment
}
etag
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": AddNoteToMemberInput}
Response
{
"data": {
"addNoteToMember": {
"member": Member,
"error": GenericError,
"clientMutationId": 4
}
}
}
updateNote
Description
rate limit 60 call(s) per app per mintue
scope
["api:admin", "note:update"]
Response
Returns an UpdateNotePayload
Arguments
| Name | Description |
|---|---|
input - UpdateNoteInput! |
Example
Query
mutation UpdateNote($input: UpdateNoteInput!) {
updateNote(input: $input) {
note {
id
_id
content
authorId
createdAt
updatedAt
etag
}
error {
name
code
message
}
clientMutationId
}
}
Variables
{"input": UpdateNoteInput}
Response
{
"data": {
"updateNote": {
"note": Note,
"error": GenericError,
"clientMutationId": 4
}
}
}
Notification
createNotification
Description
A function to create notifiction for an app.
rate limit
10 call(s) per app per mintue
scope
["api:admin", "notification:create"]
Response
Returns a CreateNotificationPayload
Arguments
| Name | Description |
|---|---|
input - CreateNotificationInput |
Example
Query
mutation CreateNotification($input: CreateNotificationInput) {
createNotification(input: $input) {
notification {
id
_id
createdAt
updatedAt
app {
...AppFragment
}
appId
type
color
title
status
message
buttons {
...NotificationButtonFragment
}
backgroundTaskId
linkTo
new
etag
}
clientMutationId
}
}
Variables
{"input": CreateNotificationInput}
Response
{
"data": {
"createNotification": {
"notification": Notification,
"clientMutationId": 4
}
}
}
Tree
createTree
Description
A function to create tree.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "botbuilder:manage", "tree:create"]
Response
Returns a CreateTreePayload
Arguments
| Name | Description |
|---|---|
input - CreateTreeInput! |
Example
Query
mutation CreateTree($input: CreateTreeInput!) {
createTree(input: $input) {
tree {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
globalNodes {
...NodeObjectFragment
}
globalNodeIds
nodes {
...NodeObjectFragment
}
nodeIds
workspace {
...WorkspaceFragment
}
version
versionAlias
ancestorTree {
...TreeFragment
}
siblingTrees {
...TreeFragment
}
tags
stash {
...NodeObjectFragment
}
etag
configMapSchema
configMap
type
system
templateTreeId
templateTree {
...TreeFragment
}
locked
}
clientMutationId
}
}
Variables
{"input": CreateTreeInput}
Response
{
"data": {
"createTree": {"tree": Tree, "clientMutationId": 4}
}
}
updateTree
Description
A function to update tree.
rate limit
10 call(s) per app per mintue
scope
["api:admin", "botbuilder:manage", "tree:updateBasicInfo", "tree:updateNodes", "tree:updateTreeSetting"]
Input params scope
"name"
scope: ["api:admin", "tree:updateBasicInfo", "botbuilder:manage"]
"description"
scope: ["api:admin", "tree:updateBasicInfo", "botbuilder:manage"]
"globalNodes"
scope: ["api:admin", "tree:updateNodes", "botbuilder:manage"]
"nodes"
scope: ["api:admin", "tree:updateNodes", "botbuilder:manage"]
"configMapSchema"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"configMap"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"type"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"templateTreeId"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"versionAlias"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"tags"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
"system"
scope: ["api:admin", "tree:updateTreeSetting", "botbuilder:manage"]
Response
Returns an UpdateTreePayload
Arguments
| Name | Description |
|---|---|
input - UpdateTreeInput! |
Example
Query
mutation UpdateTree($input: UpdateTreeInput!) {
updateTree(input: $input) {
tree {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
globalNodes {
...NodeObjectFragment
}
globalNodeIds
nodes {
...NodeObjectFragment
}
nodeIds
workspace {
...WorkspaceFragment
}
version
versionAlias
ancestorTree {
...TreeFragment
}
siblingTrees {
...TreeFragment
}
tags
stash {
...NodeObjectFragment
}
etag
configMapSchema
configMap
type
system
templateTreeId
templateTree {
...TreeFragment
}
locked
}
clientMutationId
}
}
Variables
{"input": UpdateTreeInput}
Response
{
"data": {
"updateTree": {"tree": Tree, "clientMutationId": 4}
}
}
deleteTree
Description
A function to delete tree.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "botbuilder:manage", "tree:delete"]
Response
Returns a DeleteTreePayload
Arguments
| Name | Description |
|---|---|
input - DeleteTreeInput! |
Example
Query
mutation DeleteTree($input: DeleteTreeInput!) {
deleteTree(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteTreeInput}
Response
{
"data": {
"deleteTree": {"clientMutationId": "4"}
}
}
importTrees
Description
A function to import tree.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "botbuilder:manage", "tree:create", "node:create", "trigger:create", "condition:create", "action:create", "response:create", "localeGroup:create"]
Input params scope
"trees"
scope: ["api:admin", "botbuilder:manage", "tree:create"]
"nodes"
scope: ["api:admin", "botbuilder:manage", "node:create"]
"triggers"
scope: ["api:admin", "botbuilder:manage", "trigger:create"]
"conditions"
scope: ["api:admin", "botbuilder:manage", "condition:create"]
"actions"
scope: ["api:admin", "botbuilder:manage", "action:create"]
"responses"
scope: ["api:admin", "botbuilder:manage", "response:create"]
"localeGroups"
scope: ["api:admin", "botbuilder:manage", "localeGroup:create"]
Response
Returns an ImportTreesPayload
Arguments
| Name | Description |
|---|---|
input - ImportTreesInput! |
Example
Query
mutation ImportTrees($input: ImportTreesInput!) {
importTrees(input: $input) {
trees {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
globalNodes {
...NodeObjectFragment
}
globalNodeIds
nodes {
...NodeObjectFragment
}
nodeIds
workspace {
...WorkspaceFragment
}
version
versionAlias
ancestorTree {
...TreeFragment
}
siblingTrees {
...TreeFragment
}
tags
stash {
...NodeObjectFragment
}
etag
configMapSchema
configMap
type
system
templateTreeId
templateTree {
...TreeFragment
}
locked
}
uninstalledIntegrations {
icon
integrationName
integrationId
build
version
isPlatform
private
}
}
}
Variables
{"input": ImportTreesInput}
Response
{
"data": {
"importTrees": {
"trees": [Tree],
"uninstalledIntegrations": [UninstalledIntegration]
}
}
}
batchCreateAppIntegrationForTree
Description
A function to install required integrations and then import tree.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "botbuilder:manage", "tree:create", "node:create", "trigger:create", "condition:create", "action:create", "response:create", "localeGroup:create"]
Input params scope
"trees"
scope: ["api:admin", "botbuilder:manage", "tree:create"]
"nodes"
scope: ["api:admin", "botbuilder:manage", "node:create"]
"triggers"
scope: ["api:admin", "botbuilder:manage", "trigger:create"]
"conditions"
scope: ["api:admin", "botbuilder:manage", "condition:create"]
"actions"
scope: ["api:admin", "botbuilder:manage", "action:create"]
"responses"
scope: ["api:admin", "botbuilder:manage", "response:create"]
"localeGroups"
scope: ["api:admin", "botbuilder:manage", "localeGroup:create"]
Response
Returns a BatchCreateAppIntegrationForTreePayload
Arguments
| Name | Description |
|---|---|
input - BatchCreateAppIntegrationForTreeInput! |
Example
Query
mutation BatchCreateAppIntegrationForTree($input: BatchCreateAppIntegrationForTreeInput!) {
batchCreateAppIntegrationForTree(input: $input) {
errors {
error {
...endpointErrorFragment
}
integrationId
build
}
trees {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
globalNodes {
...NodeObjectFragment
}
globalNodeIds
nodes {
...NodeObjectFragment
}
nodeIds
workspace {
...WorkspaceFragment
}
version
versionAlias
ancestorTree {
...TreeFragment
}
siblingTrees {
...TreeFragment
}
tags
stash {
...NodeObjectFragment
}
etag
configMapSchema
configMap
type
system
templateTreeId
templateTree {
...TreeFragment
}
locked
}
clientMutationId
}
}
Variables
{"input": BatchCreateAppIntegrationForTreeInput}
Response
{
"data": {
"batchCreateAppIntegrationForTree": {
"errors": [BatchCreateAppIntegrationError],
"trees": [Tree],
"clientMutationId": "4"
}
}
}
duplicateTree
Description
A function to delete tree.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "botbuilder:manage", "tree:duplicate"]
Response
Returns a DuplicateTreePayload
Arguments
| Name | Description |
|---|---|
input - DuplicateTreeInput! |
Example
Query
mutation DuplicateTree($input: DuplicateTreeInput!) {
duplicateTree(input: $input) {
tree {
id
_id
createdAt
updatedAt
name
description
app {
...AppFragment
}
appId
globalNodes {
...NodeObjectFragment
}
globalNodeIds
nodes {
...NodeObjectFragment
}
nodeIds
workspace {
...WorkspaceFragment
}
version
versionAlias
ancestorTree {
...TreeFragment
}
siblingTrees {
...TreeFragment
}
tags
stash {
...NodeObjectFragment
}
etag
configMapSchema
configMap
type
system
templateTreeId
templateTree {
...TreeFragment
}
locked
}
clientMutationId
}
}
Variables
{"input": DuplicateTreeInput}
Response
{
"data": {
"duplicateTree": {"tree": Tree, "clientMutationId": 4}
}
}
exportTrees
Description
A function to export trees.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "tree:export"]
Response
Returns an ExportTreesPayload
Arguments
| Name | Description |
|---|---|
input - ExportTreesInput! |
Example
Query
mutation ExportTrees($input: ExportTreesInput!) {
exportTrees(input: $input) {
url
trees
nodes
triggers
conditions
actions
responses
localeGroups
}
}
Variables
{"input": ExportTreesInput}
Response
{
"data": {
"exportTrees": {
"url": "abc123",
"trees": [{}],
"nodes": [{}],
"triggers": [{}],
"conditions": [{}],
"actions": [{}],
"responses": [{}],
"localeGroups": [{}]
}
}
}
Action
createAction
Description
A function to create action.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "botbuilder:manage", "condition:create"]
Response
Returns a CreateActionPayload
Arguments
| Name | Description |
|---|---|
input - CreateActionInput! |
Example
Query
mutation CreateAction($input: CreateActionInput!) {
createAction(input: $input) {
action {
id
_id
createdAt
updatedAt
name
description
functionString
app {
...AppFragment
}
etag
tags
history
}
clientMutationId
}
}
Variables
{"input": CreateActionInput}
Response
{
"data": {
"createAction": {
"action": Action,
"clientMutationId": 4
}
}
}
updateAction
Description
A function to update action.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "botbuilder:manage", "condition:update"]
Response
Returns an UpdateActionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateActionInput! |
Example
Query
mutation UpdateAction($input: UpdateActionInput!) {
updateAction(input: $input) {
action {
id
_id
createdAt
updatedAt
name
description
functionString
app {
...AppFragment
}
etag
tags
history
}
clientMutationId
}
}
Variables
{"input": UpdateActionInput}
Response
{
"data": {
"updateAction": {
"action": Action,
"clientMutationId": 4
}
}
}
deleteAction
Description
A function to delete action.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "botbuilder:manage", "condition:delete"]
Response
Returns a DeleteActionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteActionInput! |
Example
Query
mutation DeleteAction($input: DeleteActionInput!) {
deleteAction(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteActionInput}
Response
{"data": {"deleteAction": {"clientMutationId": 4}}}
Node
createNode
Description
A function to create node.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "node:create"]
Response
Returns a CreateNodePayload
Arguments
| Name | Description |
|---|---|
input - CreateNodeInput! |
Example
Query
mutation CreateNode($input: CreateNodeInput!) {
createNode(input: $input) {
node {
id
_id
createdAt
updatedAt
name
description
trigger {
...TriggerFragment
}
triggerId
preActions {
...ActionFragment
}
preActionIds
responses {
...ResponseFragment
}
responseIds
postActions {
...ActionFragment
}
postActionIds
actions {
...ActionFragment
}
actionIds
priority
path
app {
...AppFragment
}
appId
compositeId
tree {
...TreeFragment
}
treeId
locked
global
redirect {
...RedirectFragment
}
analytics {
...AnalyticsFragment
}
memberTagging {
...MemberTaggingFragment
}
type
dialogflow {
...DialogflowSettingsFragment
}
luis {
...LuisSettingsFragment
}
etag
history
colour
tags
templateTreeId
saveCompositeId
}
clientMutationId
}
}
Variables
{"input": CreateNodeInput}
Response
{
"data": {
"createNode": {
"node": NodeObject,
"clientMutationId": "4"
}
}
}
updateNode
Description
A function to update node.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "node:update"]
Response
Returns an UpdateNodePayload
Arguments
| Name | Description |
|---|---|
input - UpdateNodeInput! |
Example
Query
mutation UpdateNode($input: UpdateNodeInput!) {
updateNode(input: $input) {
node {
id
_id
createdAt
updatedAt
name
description
trigger {
...TriggerFragment
}
triggerId
preActions {
...ActionFragment
}
preActionIds
responses {
...ResponseFragment
}
responseIds
postActions {
...ActionFragment
}
postActionIds
actions {
...ActionFragment
}
actionIds
priority
path
app {
...AppFragment
}
appId
compositeId
tree {
...TreeFragment
}
treeId
locked
global
redirect {
...RedirectFragment
}
analytics {
...AnalyticsFragment
}
memberTagging {
...MemberTaggingFragment
}
type
dialogflow {
...DialogflowSettingsFragment
}
luis {
...LuisSettingsFragment
}
etag
history
colour
tags
templateTreeId
saveCompositeId
}
clientMutationId
}
}
Variables
{"input": UpdateNodeInput}
Response
{
"data": {
"updateNode": {
"node": NodeObject,
"clientMutationId": "4"
}
}
}
deleteNode
Description
A function to delete node.
rate limit
5 call(s) per app per mintue
scope
["api:admin", "node:delete"]
Response
Returns a DeleteNodePayload
Arguments
| Name | Description |
|---|---|
input - DeleteNodeInput! |
Example
Query
mutation DeleteNode($input: DeleteNodeInput!) {
deleteNode(input: $input) {
clientMutationId
}
}
Variables
{"input": DeleteNodeInput}
Response
{
"data": {
"deleteNode": {
"clientMutationId": "abc123"
}
}
}
Types
Action
Example
{
"id": 4,
"_id": "4",
"createdAt": {},
"updatedAt": {},
"name": "abc123",
"description": "abc123",
"functionString": "xyz789",
"app": App,
"etag": "4",
"tags": ["xyz789"],
"history": [{}]
}
ActionConnection
Fields
| Field Name | Description |
|---|---|
edges - [ActionEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [ActionEdge],
"pageInfo": PageInfo
}
ActionEdge
ActiveMemberCounter
ActiveMemberCounterConnection
Fields
| Field Name | Description |
|---|---|
data - [ActiveMemberCounter] | |
pageInfo - PageInfo | |
total_no_of_member - Long | |
total_no_of_comment_member - Long |
Example
{
"data": [ActiveMemberCounter],
"pageInfo": PageInfo,
"total_no_of_member": {},
"total_no_of_comment_member": {}
}
AddNoteToMemberInput
Fields
| Input Field | Description |
|---|---|
memberId - ID! | |
note - NoteInput! | |
clientMutationId - ID |
Example
{"memberId": 4, "note": NoteInput, "clientMutationId": 4}
AddNoteToMemberPayload
Fields
| Field Name | Description |
|---|---|
member - Member | |
error - GenericError | |
clientMutationId - ID |
Example
{
"member": Member,
"error": GenericError,
"clientMutationId": "4"
}
AddOutletInPairInput
AddOutletInPairPayload
Address
AddressInput
Admin
Example
{
"id": 4,
"_id": "4",
"createdAt": {},
"updatedAt": {},
"app": App,
"firstName": "xyz789",
"lastName": "abc123",
"name": "abc123",
"profilePic": "xyz789",
"channel": Channel,
"externalId": "4",
"meta": {},
"tags": ["abc123"],
"gender": "xyz789",
"locale": "xyz789",
"active": false,
"etag": "4"
}
AdminConnection
Fields
| Field Name | Description |
|---|---|
edges - [AdminEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [AdminEdge],
"pageInfo": PageInfo
}
AdminEdge
Agenda
Fields
| Field Name | Description |
|---|---|
id - ID! | |
_id - ID! | |
createdAt - Long! | |
updatedAt - Long | |
app - App! | |
appId - ID | |
member - Member | |
memberId - ID | |
channel - Channel | |
channelId - ID | |
responses - JSON | |
tree - Tree | |
treeId - ID | |
node - NodeObject | |
nodeCompositeId - ID | |
nextRunAt - Long | |
completed - Boolean | |
lastRunAt - Long | |
pattern - String | |
runUntil - Long | |
type - String | |
priority - Int | |
subscriptionPush - AgendaSubscriptionPushConfig | |
tag - String | |
meta - JSON | |
etag - ID |
Example
{
"id": 4,
"_id": 4,
"createdAt": {},
"updatedAt": {},
"app": App,
"appId": "4",
"member": Member,
"memberId": "4",
"channel": Channel,
"channelId": 4,
"responses": {},
"tree": Tree,
"treeId": 4,
"node": NodeObject,
"nodeCompositeId": "4",
"nextRunAt": {},
"completed": true,
"lastRunAt": {},
"pattern": "xyz789",
"runUntil": {},
"type": "xyz789",
"priority": 987,
"subscriptionPush": AgendaSubscriptionPushConfig,
"tag": "abc123",
"meta": {},
"etag": 4
}
AgendaSubscriptionPushConfig
AgendaSubscriptionPushConfigInput
AggregateDataSourceDocsInput
Description
Input type for aggregating datasource docs.
Example
{
"collectionName": 4,
"pipeline": {},
"options": {},
"clientMutationId": "4"
}
AggregateDataSourceDocsPayload
Analytics
AnalyticsCustomEventCounterConnectionRD
Fields
| Field Name | Description |
|---|---|
edges - [AnalyticsCustomEventCounterEdgeRD] | |
total_no_of_analytics - Long! | |
pageInfo - PageInfo |
Example
{
"edges": [AnalyticsCustomEventCounterEdgeRD],
"total_no_of_analytics": {},
"pageInfo": PageInfo
}
AnalyticsCustomEventCounterConnectionTB
Fields
| Field Name | Description |
|---|---|
edges - [AnalyticsCustomEventCounterEdgeTB] | |
total_no_of_analytics - Long! | |
pageInfo - PageInfo |
Example
{
"edges": [AnalyticsCustomEventCounterEdgeTB],
"total_no_of_analytics": {},
"pageInfo": PageInfo
}
AnalyticsCustomEventCounterEdgeRD
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - AnalyticsCustomEventCounterRD |
Example
{
"cursor": "4",
"node": AnalyticsCustomEventCounterRD
}
AnalyticsCustomEventCounterEdgeTB
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - AnalyticsCustomEventCounterTB |
Example
{
"cursor": "4",
"node": AnalyticsCustomEventCounterTB
}
AnalyticsCustomEventCounterRD
Example
{
"app": App,
"appId": "4",
"category": "abc123",
"action": "abc123",
"label": "abc123",
"no_of_analytics": {},
"no_of_unique_member_analytics": {},
"member": "abc123"
}
AnalyticsCustomEventCounterTB
Example
{
"app": App,
"appId": 4,
"channel": Channel,
"channelId": "4",
"category": "abc123",
"action": "xyz789",
"label": "abc123",
"bucket": {},
"no_of_analytics": {}
}
AnalyticsInput
ApiScope
Fields
| Field Name | Description |
|---|---|
id - ID! | rate limit 5 call(s) per app per mintue ["api:admin"] |
_id - ID! | rate limit 5 call(s) per app per mintue ["api:admin"] |
distinctDataSourceData - JSON | A function to search distinct datasource doc. 5 call(s) per app per mintue ["api:admin", "dataSource:listDocs"] |
fetchDataSourceData - JSON | A function to search datasource doc. 10 call(s) per app per mintue ["api:admin", "dataSource:listDocs"] |
Arguments
| |
fetchGeoNearDataSourceData - JSON | A function to search datasource doc based on location. 5 call(s) per app per mintue ["api:admin", "dataSource:listDocs"] |
Arguments
| |
memberRaw - JSON | A function to search for a member. Currently deprecated. 5 call(s) per app per mintue ["api:admin", "member:getDetails"] Use ApiScope.member |
member - Member | A function to search for a memeber. Can be used to get a single member using memberID or externalID. 600 call(s) per app per mintue ["conversation:read", "api:admin", "member:getDetails"] |
members - MemberConnection | A function to search for a collection of members. Can also be used with varies filters. 30 call(s) per app per mintue ["api:admin", "member:getDetails"] |
Arguments
| |
admins - AdminConnection | A function to search for a collection of admins. Can also be used with varies filters. Currently deprecated. 5 call(s) per app per mintue ["api:admin", "dashboard:listTicketing"] No longer supported |
Arguments
| |
channel - Channel | A function to get channel detail. 30 call(s) per app per mintue ["api:admin", "channel:getAvailabilities", "channel:getBasicInfo", "channel:getBroadcastGroupSettings", "channel:getLiveChatSettings", "channel:getPlatformInfo", "channel:getPlatformSettings", "channel:getTreeSettings"] |
Arguments
| |
conversationHistory - ChatConnection | A function to get chat history. Can also be used with varies filters. 30 call(s) per app per mintue ["conversation:read", "member:getConversation", "api:admin"] |
Arguments
| |
assignments - AssignmentConnection | A function to get a collection of assignments. Can also be used with varies filters. Currently deprecated. 5 call(s) per app per mintue ["api:admin", "dashboard:listAssignment"] No longer supported |
Arguments
| |
assignment - Assignment | A function to get an assignment using the assignmentId. Currently deprecated. 5 call(s) per app per mintue ["api:admin", "dashboard:listAssignment"] No longer supported |
Arguments
| |
groups - GroupConnection | A function to get a collection of groups. Can also be used with varies filters. Currently deprecated. 5 call(s) per app per mintue ["api:admin", "dashboard:listAssignment"] No longer supported |
Arguments
| |
installedIntegrations - [AppIntegration] | Get list of installed integrations 5 call(s) per app per mintue ["api:admin", "appIntegration:get"] |
Arguments
| |
installedIntegration - AppIntegration | Get an installed integration using integrationId and build or appIntegrationId 5 call(s) per app per mintue ["api:admin", "appIntegration:get"] |
integrations - JSON | A function to get the integrations of an app. Only gives integrations for app that matches the user's. Currently deprecated. 5 call(s) per app per mintue ["api:admin", "integration:list"] No longer supported |
app - App | A function to get app info 20 call(s) per app per mintue ["api:admin", "appInfo:get", "appSettings:get", "dataSource:listDatasources", "billing:getSubscription", "teamMember:list"] |
Arguments
| |
userContext - JSON | A function to get token info 5 call(s) per app per mintue |
Arguments
| |
channels - ChannelConnection | A function to get channels. 30 call(s) per app per mintue ["api:admin", "channel:list"] |
Arguments
| |
tree - Tree | A function to get tree info. 5 call(s) per app per mintue ["api:admin", "botbuilder:read", "tree:getBasicInfo", "tree:getDetails", "tree:getNodes", "tree:getTreeSetting", "appInfo:get", "appSettings:get"] |
Arguments
| |
whatsAppFile - WhatsAppFileUrl | A function to get the URL of a file in WhatsApp. Both mediaId and channelId must be present. Currently deprecated. 60 call(s) per app per mintue ["api:admin", "whatsapp:getFile"] No longer supported |
whatsAppTemplate - WhatsAppMessageTemplateConnection | A function to get a collection of WhatsApp template. Either integrationId or channelId must be used. Currently deprecated. 5 call(s) per app per mintue ["api:admin", "whatsappMessageTemplates:list"] No longer supported |
Arguments
| |
postCommentAnalyticsOverview - PostCommentAnalyticsOverviewConnection | A function to get Comment Analytics Overview. Can also be used with varies filters. Currently deprecated. 5 call(s) per app per mintue ["api:admin", "dashboard:listCommentReply"] No longer supported |
Arguments
| |
nlpAnalyticsOverview - NLPAnalyticsCounterConnection | A function to get NLP Analytics Overview. Either integrationId or channelId must be used. 5 call(s) per app per mintue ["api:admin", "dashboard:listNlpAnalytics"] |
Arguments
| |
analyticsCustomEventOverviewDateHistogram - AnalyticsCustomEventCounterConnectionTB | A function used to get the Overview Date Histogram of an Analytics Custom Event. Can not query for member or no_of_unique_member_analytics. 5 call(s) per app per mintue ["api:admin", "dashboard:listAnalytics"] |
Arguments
| |
analyticsCustomEventOverviewTable - AnalyticsCustomEventCounterConnectionRD | A function used to get the Overview Table of an Analytics Custom Event. Either member or no_of_unique_member_analytics must be in the query fields. 5 call(s) per app per mintue ["api:admin", "dashboard:listAnalytics"] |
Arguments
| |
dailyActiveMemberOverview - DailyActiveMemberOverviewPayload | A function used to get Daily Active member. 5 call(s) per app per mintue ["api:admin", "dashboard:listUsers"] |
Arguments
| |
activeMemberCounter - ActiveMemberCounterConnection | A function used to get active member count. 5 call(s) per app per mintue ["api:admin", "dashboard:listUsers"] |
Arguments
| |
newMemberCounter - NewMemberCounterConnection | A function used to get new member count. 5 call(s) per app per mintue ["api:admin", "dashboard:listUsers"] |
Arguments
| |
actions - ActionConnection | A function used to get actions list. 5 call(s) per app per mintue ["api:admin", "action:read"] |
Arguments
| |
audiences - AudienceConnection | A function used to get audience list. 5 call(s) per app per mintue ["api:admin", "audience:read"] |
Arguments
| |
conditions - ConditionConnection | A function used to get condition list. Currently deprecated. 5 call(s) per app per mintue ["api:admin", "condition:read"] No longer supported |
Arguments
| |
localeGroups - LocaleGroupConnection | A function used to get locale group list. 5 call(s) per app per mintue ["api:admin", "localeGroup:read"] |
Arguments
| |
nodes - NodeObjectConnection | A function used to get node list. 5 call(s) per app per mintue ["api:admin", "node:read"] |
Arguments
| |
priorityGroups - PriorityGroupConnection | A function used to get priority group list. 5 call(s) per app per mintue ["api:admin", "priorityGroup:list"] |
Arguments
| |
responses - ResponseConnection | A function used to get response list. 5 call(s) per app per mintue ["api:admin", "response:read"] |
Arguments
| |
subscriptionPushes - SubscriptionPushConnection | A function used to get subscription push list. 5 call(s) per app per mintue ["api:admin", "push:list"] |
Arguments
| |
trees - TreeConnection | A function used to get tree list. 5 call(s) per app per mintue ["api:admin", "tree:read", "tree:list"] |
Arguments
| |
triggers - TriggerConnection | A function used to get trigger list. 5 call(s) per app per mintue ["api:admin", "trigger:read"] |
Arguments
| |
file - RetrieveFilePayload | A function used to get file from fileId. 60 call(s) per app per mintue ["api:admin", "file:admin", "file:get", "medialibrary:get"] |
Arguments
| |
chat - Chat | A function used to get chat from either chatId or messageId. 60 call(s) per app per mintue ["conversation:read", "member:getConversation", "api:admin"] |
backgroundTask - BackgroundTask | To get info of a background task, typically used to check the status of the background task. 12 call(s) per app per mintue ["backgroundTask:get"] |
Arguments
| |
Example
{
"id": "4",
"_id": 4,
"distinctDataSourceData": {},
"fetchDataSourceData": {},
"fetchGeoNearDataSourceData": {},
"memberRaw": {},
"member": Member,
"members": MemberConnection,
"admins": AdminConnection,
"channel": Channel,
"conversationHistory": ChatConnection,
"assignments": AssignmentConnection,
"assignment": Assignment,
"groups": GroupConnection,
"installedIntegrations": [AppIntegration],
"installedIntegration": AppIntegration,
"integrations": {},
"app": App,
"userContext": {},
"channels": ChannelConnection,
"tree": Tree,
"whatsAppFile": WhatsAppFileUrl,
"whatsAppTemplate": WhatsAppMessageTemplateConnection,
"postCommentAnalyticsOverview": PostCommentAnalyticsOverviewConnection,
"nlpAnalyticsOverview": NLPAnalyticsCounterConnection,
"analyticsCustomEventOverviewDateHistogram": AnalyticsCustomEventCounterConnectionTB,
"analyticsCustomEventOverviewTable": AnalyticsCustomEventCounterConnectionRD,
"dailyActiveMemberOverview": DailyActiveMemberOverviewPayload,
"activeMemberCounter": ActiveMemberCounterConnection,
"newMemberCounter": NewMemberCounterConnection,
"actions": ActionConnection,
"audiences": AudienceConnection,
"conditions": ConditionConnection,
"localeGroups": LocaleGroupConnection,
"nodes": NodeObjectConnection,
"priorityGroups": PriorityGroupConnection,
"responses": ResponseConnection,
"subscriptionPushes": SubscriptionPushConnection,
"trees": TreeConnection,
"triggers": TriggerConnection,
"file": RetrieveFilePayload,
"chat": Chat,
"backgroundTask": BackgroundTask
}
App
Fields
| Field Name | Description |
|---|---|
id - ID! | scope ["api:admin", "appInfo:get"] |
_id - ID! | scope ["api:admin", "appInfo:get"] |
createdAt - Long! | scope ["api:admin", "appInfo:get"] |
updatedAt - Long | scope ["api:admin", "appInfo:get"] |
name - String! | scope ["api:admin", "appInfo:get"] |
description - String | scope ["api:admin", "appInfo:get"] |
inlets - [Channel] | scope ["api:admin", "appSettings:get"] |
outlets - [Channel] | scope ["api:admin", "appSettings:get"] |
meta - JSON | scope ["api:admin", "appSettings:get"] |
integrations - [JSON] | scope ["api:admin", "appSettings:get"] |
activated - Boolean | scope ["api:admin", "appInfo:get"] |
teamMembers - [TeamMember] | scope ["api:admin", "appSettings:get", "teamMember:list"] |
dataSources - [DataSource] | scope ["api:admin", "dataSource:listDatasources"] |
dataSource - DataSource | scope ["api:admin", "dataSource:listDatasources"] |
Arguments
| |
pairs - [Pair] | scope ["api:admin", "appSettings:get"] |
managedBy - Partner | scope ["api:admin", "appInfo:get"] |
managementType - String | scope ["api:admin", "appSettings:get"] |
etag - ID | scope ["api:admin", "appInfo:get"] |
Example
{
"id": "4",
"_id": "4",
"createdAt": {},
"updatedAt": {},
"name": "abc123",
"description": "xyz789",
"inlets": [Channel],
"outlets": [Channel],
"meta": {},
"integrations": [{}],
"activated": false,
"teamMembers": [TeamMember],
"dataSources": [DataSource],
"dataSource": DataSource,
"pairs": [Pair],
"managedBy": Partner,
"managementType": "abc123",
"etag": 4
}
AppIntegration
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
id - ID! | |
app - App! | |
appId - ID | |
description - String | |
alias - String! | |
meta - JSON | |
integration_id - ID | |
integrationKey - String | |
integrationId - ID | |
features - [String] | |
build - Int | |
etag - ID | |
createdAt - Long! | |
updatedAt - Long | |
signature - String | |
secret - String | |
channel - Channel | |
integrationName - String | |
integrationDescription - String | |
latestPublished - Int | |
isLatestPublished - Boolean | |
icon - String | |
author - Author | |
authorId - ID | |
supportEmail - String | |
readme - String | |
termsAndConditionsUrl - String | |
privacyPolicyUrl - String | |
websiteUrl - String | |
builderSidebarView - IntegrationView | |
dashboardView - IntegrationView | |
customView - IntegrationView | |
changelog - String | |
scopes - [String] | |
endpoints - IntegrationEndpoints | |
resourceTemplates - [ResourceTemplate] | |
Arguments
| |
defaultResourceTemplate - ResourceTemplate | |
Arguments
| |
hooks - Hook | |
functionString - String | |
settingsView - String | |
platformSettingsView - String | |
settingsSchema - JSON | |
settingsValidatorFunctionString - String | |
trees - [IntegrationTree] | |
supportTicketing - Boolean | |
version - String | |
inbox - InboxIntegration | |
Example
{
"_id": "4",
"id": "4",
"app": App,
"appId": "4",
"description": "abc123",
"alias": "xyz789",
"meta": {},
"integration_id": 4,
"integrationKey": "abc123",
"integrationId": 4,
"features": ["xyz789"],
"build": 123,
"etag": "4",
"createdAt": {},
"updatedAt": {},
"signature": "abc123",
"secret": "xyz789",
"channel": Channel,
"integrationName": "xyz789",
"integrationDescription": "abc123",
"latestPublished": 987,
"isLatestPublished": true,
"icon": "xyz789",
"author": Author,
"authorId": "4",
"supportEmail": "abc123",
"readme": "xyz789",
"termsAndConditionsUrl": "abc123",
"privacyPolicyUrl": "xyz789",
"websiteUrl": "abc123",
"builderSidebarView": IntegrationView,
"dashboardView": IntegrationView,
"customView": IntegrationView,
"changelog": "xyz789",
"scopes": ["xyz789"],
"endpoints": IntegrationEndpoints,
"resourceTemplates": [ResourceTemplate],
"defaultResourceTemplate": ResourceTemplate,
"hooks": Hook,
"functionString": "xyz789",
"settingsView": "xyz789",
"platformSettingsView": "abc123",
"settingsSchema": {},
"settingsValidatorFunctionString": "xyz789",
"trees": [IntegrationTree],
"supportTicketing": false,
"version": "xyz789",
"inbox": InboxIntegration
}
Assignment
Fields
| Field Name | Description |
|---|---|
id - ID! | |
_id - ID! | |
createdAt - Long! | |
updatedAt - Long | |
inlet - Channel | |
inletId - ID | |
targets - [AssignmentTarget] | |
member - Member | |
memberId - ID | |
group - Group | |
groupId - ID | |
groupExternalId - ID | |
assignedAt - Long | |
assignee - Admin | |
assigner - Admin | |
expiry - Long | |
groupInfo - JSON | |
relayMessage - JSON | |
reassignRelayMessage - JSON | |
takenMessage - String | |
app - App! | |
appId - ID | |
etag - ID | |
tags - [String] | |
inactivatedAt - Long | |
reassign - Boolean | |
history - Boolean | |
active - Boolean | |
inletGroup - Boolean | |
inletMessage - JSON | |
inletGroupInfo - JSON | |
inletGroupExternalId - ID | |
parentAssignment - Assignment | |
parentAssignmentId - ID | |
previousAssignment - Assignment | |
previousAssignmentId - ID | |
adminContactMessage - JSON | |
redirectMemberToNode - Redirect | |
label - String | |
status - String | |
meta - JSON | |
isZendesk - Boolean | |
noGroupCreation - Boolean |
Example
{
"id": 4,
"_id": "4",
"createdAt": {},
"updatedAt": {},
"inlet": Channel,
"inletId": 4,
"targets": [AssignmentTarget],
"member": Member,
"memberId": "4",
"group": Group,
"groupId": "4",
"groupExternalId": 4,
"assignedAt": {},
"assignee": Admin,
"assigner": Admin,
"expiry": {},
"groupInfo": {},
"relayMessage": {},
"reassignRelayMessage": {},
"takenMessage": "xyz789",
"app": App,
"appId": 4,
"etag": 4,
"tags": ["abc123"],
"inactivatedAt": {},
"reassign": true,
"history": false,
"active": true,
"inletGroup": false,
"inletMessage": {},
"inletGroupInfo": {},
"inletGroupExternalId": "4",
"parentAssignment": Assignment,
"parentAssignmentId": "4",
"previousAssignment": Assignment,
"previousAssignmentId": "4",
"adminContactMessage": {},
"redirectMemberToNode": Redirect,
"label": "abc123",
"status": "xyz789",
"meta": {},
"isZendesk": false,
"noGroupCreation": true
}
AssignmentConnection
Fields
| Field Name | Description |
|---|---|
edges - [AssignmentEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [AssignmentEdge],
"pageInfo": PageInfo
}
AssignmentEdge
Fields
| Field Name | Description |
|---|---|
node - Assignment | |
cursor - ID! |
Example
{"node": Assignment, "cursor": 4}
AssignmentTarget
Fields
| Field Name | Description |
|---|---|
channel - Channel | |
channelId - ID | |
admin - Admin | |
label - String | |
broadcastGroups - [BroadcastGroup] |
Example
{
"channel": Channel,
"channelId": "4",
"admin": Admin,
"label": "xyz789",
"broadcastGroups": [BroadcastGroup]
}
AttachmentUploadInput
AttachmentUploadPayload
Audience
Example
{
"id": 4,
"_id": "4",
"createdAt": {},
"updatedAt": {},
"name": "xyz789",
"description": "abc123",
"app": App,
"filter": AudienceFilter,
"channel": Channel,
"channelId": 4,
"tags": ["xyz789"],
"etag": 4
}
AudienceConnection
Fields
| Field Name | Description |
|---|---|
edges - [AudienceEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [AudienceEdge],
"pageInfo": PageInfo
}
AudienceEdge
AudienceFilter
Fields
| Field Name | Description |
|---|---|
plusMembers - [Member] | |
plusMemberIds - [ID] | |
minusMembers - [Member] | |
minusMemberIds - [ID] | |
specificMembersOnly - Boolean | |
specificMembers - [Member] | |
specificMemberIds - [ID] | |
Arguments
| |
criteria - JSON | |
criteriaMemberIds - [ID] | |
Arguments
| |
criteriaFbOTNTags - [String] | |
Example
{
"plusMembers": [Member],
"plusMemberIds": ["4"],
"minusMembers": [Member],
"minusMemberIds": ["4"],
"specificMembersOnly": false,
"specificMembers": [Member],
"specificMemberIds": ["4"],
"criteria": {},
"criteriaMemberIds": [4],
"criteriaFbOTNTags": ["abc123"]
}
AudienceFilterInput
Fields
| Input Field | Description |
|---|---|
plusMembers - [ID] | |
minusMembers - [ID] | |
specificMembersOnly - Boolean | |
specificMembers - [ID] | |
criteria - JSON | Criteria is an array of object that is translated to a member filter. Small Example: [{ "field" : "externalId", "operator" : "equal", "value" : "123" },{ "field" : "channel", "operator" : "equal", "value" : "abc" }] "criteria options": "field": "_id" | "tags" | "fbOTNTag", "filters": [{ "operator": "in" | "nin", "value": ["ID | String"]}] "field": "createdAt" | "updatedAt", "from": "epoch number", "to": "epoch number" "field": "firstName" | "lastName", "value": "String" "field": "liveChat", "value": "Boolean" "operator": "equal" | "in" | "nin" | "ne" | "regex" ("eq" does not work) "field": "String", (as long as field is not one of the aboves, example: "externalId", "channel", "locale", "gender", "botMeta.tempData.abc", "meta.def") "value": "Any" |
Example
{
"plusMembers": ["4"],
"minusMembers": ["4"],
"specificMembersOnly": false,
"specificMembers": ["4"],
"criteria": {}
}
Author
Fields
| Field Name | Description |
|---|---|
email - String |
Example
{"email": "abc123"}
BackgroundTask
Example
{
"id": "4",
"_id": 4,
"createdAt": {},
"updatedAt": {},
"app": App,
"appId": "4",
"type": "abc123",
"message": "abc123",
"status": "xyz789",
"data": {},
"meta": {},
"runAt": {},
"endAt": {},
"etag": "4"
}
BatchCreateAppIntegrationError
Fields
| Field Name | Description |
|---|---|
error - endpointError | |
integrationId - String | |
build - Int |
Example
{
"error": endpointError,
"integrationId": "abc123",
"build": 987
}
BatchCreateAppIntegrationForTreeInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
normalIntegrations - [NormalIntegrationInput] | |
platformIntegrations - [PlatformIntegrationInput] | |
trees - [JSON] | |
nodes - [JSON] | |
triggers - [JSON] | |
conditions - [JSON] | |
actions - [JSON] | |
responses - [JSON] | |
localeGroups - [JSON] | |
url - String | |
prefix - String | |
forceKeepResponsePlatforms - [String] | List of Platforms to keep the response. Ex: ["facebook", "whatsapp-cloud"] |
clientMutationId - ID |
Example
{
"app": "4",
"normalIntegrations": [NormalIntegrationInput],
"platformIntegrations": [PlatformIntegrationInput],
"trees": [{}],
"nodes": [{}],
"triggers": [{}],
"conditions": [{}],
"actions": [{}],
"responses": [{}],
"localeGroups": [{}],
"url": "xyz789",
"prefix": "xyz789",
"forceKeepResponsePlatforms": ["xyz789"],
"clientMutationId": "4"
}
BatchCreateAppIntegrationForTreePayload
Fields
| Field Name | Description |
|---|---|
errors - [BatchCreateAppIntegrationError] | |
trees - [Tree] | |
clientMutationId - ID |
Example
{
"errors": [BatchCreateAppIntegrationError],
"trees": [Tree],
"clientMutationId": "4"
}
BatchCreateChatInput
Fields
| Input Field | Description |
|---|---|
chats - [ChatInput] | Array of chat object |
sendOutbound - Boolean | |
clientMutationId - ID | ID generated by relay client for tracking the progress |
Example
{
"chats": [ChatInput],
"sendOutbound": false,
"clientMutationId": 4
}
BatchCreateChatPayload
BatchUpdateMemberInput
Fields
| Input Field | Description |
|---|---|
memberIds - [ID] | Member Ids (Either memberIds or externalIds) |
externalIds - [ID] | Member external Ids (Either memberIds or externalIds) |
channel - ID | Channel ID (required when using externalIds) |
tags - [String] | Member tags |
gender - String | Member gender |
locale - String | Member locale |
option - MongoDBArrayOption | Tags manipulation option |
app - ID | |
clientMutationId - ID |
Example
{
"memberIds": [4],
"externalIds": ["4"],
"channel": 4,
"tags": ["xyz789"],
"gender": "abc123",
"locale": "xyz789",
"option": "set",
"app": 4,
"clientMutationId": 4
}
BatchUpdateMemberPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
Boolean
Description
The Boolean scalar type represents true or false.
BotMeta
BotMetaInput
BroadcastGroup
Channel
Fields
| Field Name | Description |
|---|---|
id - ID! | scope ["api:admin", "channel:getBasicInfo"] |
_id - ID! | scope ["api:admin", "channel:getBasicInfo"] |
createdAt - Long! | scope ["api:admin", "channel:getBasicInfo"] |
updatedAt - Long | scope ["api:admin", "channel:getBasicInfo"] |
name - String! | scope ["api:admin", "channel:getBasicInfo"] |
description - String | scope ["api:admin", "channel:getBasicInfo"] |
app - App! | scope ["api:admin", "channel:getDetails"] |
appId - ID | scope ["api:admin", "channel:getDetails"] |
type - String | scope ["api:admin", "channel:getBasicInfo"] |
relayWebhooks - [String] | scope ["api:admin", "channel:getDetails"] No longer supported |
webhooks - JSON | scope ["api:admin", "channel:getDetails"] No longer supported |
verificationToken - String | scope ["api:admin", "channel:getDetails"] No longer supported |
channelSecret - String | scope ["api:admin", "channel:getDetails"] |
info - JSON | scope ["api:admin", "channel:getPlatformInfo"] No longer supported |
broadcastGroups - [ChannelBroadcastGroup] | scope ["api:admin", "channel:getBroadcastGroupSettings"] No longer supported |
meta - JSON | scope ["api:admin", "channel:getTreeSettings"] |
trees - [Tree] | scope ["api:admin", "channel:getTreeSettings"] No longer supported |
globalNodes - [NodeObject] | scope ["api:admin", "channel:getTreeSettings"] No longer supported |
priorityGroups - [ChannelPriorityGroup] | scope ["api:admin", "channel:getTreeSettings"] No longer supported |
tags - [String] | scope ["api:admin", "channel:getBasicInfo"] |
inletGroup - Boolean | scope ["api:admin", "channel:getBroadcastGroupSettings"] No longer supported |
etag - ID | scope ["api:admin", "channel:getBasicInfo"] |
on - Boolean | scope ["api:admin", "channel:getAvailabilities"] |
sendOutletMessageViaBot - Boolean | scope ["api:admin", "channel:getBroadcastGroupSettings"] No longer supported |
livechatAgendas - JSON | scope ["api:admin", "channel:getLiveChatSettings"] No longer supported |
liveChatAgendaObjects - [LiveChatAgenda] | scope ["api:admin", "channel:getLiveChatSettings"] No longer supported |
availability - JSON | scope ["api:admin", "channel:getAvailabilities"] No longer supported |
exclusiveLiveChat - Boolean | scope ["api:admin", "channel:getBasicInfo"] No longer supported |
locked - Boolean | scope ["api:admin", "channel:getBasicInfo"] No longer supported |
wabaStatus - String | scope ["api:admin", "channel:getPlatformSettings"] No longer supported |
wabaError - String | scope ["api:admin", "channel:getPlatformSettings"] No longer supported |
wabaInfo - JSON | scope ["api:admin", "channel:getPlatformSettings"] No longer supported |
wabaIntegration - WABAIntegration | scope ["api:admin", "channel:getPlatformSettings"] No longer supported |
environment - ChannelEnvironment | scope ["api:admin", "channel:getEnvironmentInfo"] |
Arguments
| |
environments - [ChannelEnvironment] | scope ["api:admin", "channel:getEnvironmentInfo"] |
incomingWebhooks - [ChannelIncomingWebhook] | scope ["api:admin", "channel:getDetails"] |
archived - Boolean | scope ["api:admin", "channel:getBasicInfo"] |
archivedAt - Long | scope ["api:admin", "channel:getBasicInfo"] |
connected - Boolean | scope ["api:admin", "channel:getBasicInfo"] |
Example
{
"id": 4,
"_id": "4",
"createdAt": {},
"updatedAt": {},
"name": "xyz789",
"description": "abc123",
"app": App,
"appId": "4",
"type": "xyz789",
"relayWebhooks": ["xyz789"],
"webhooks": {},
"verificationToken": "abc123",
"channelSecret": "xyz789",
"info": {},
"broadcastGroups": [ChannelBroadcastGroup],
"meta": {},
"trees": [Tree],
"globalNodes": [NodeObject],
"priorityGroups": [ChannelPriorityGroup],
"tags": ["abc123"],
"inletGroup": true,
"etag": 4,
"on": true,
"sendOutletMessageViaBot": true,
"livechatAgendas": {},
"liveChatAgendaObjects": [LiveChatAgenda],
"availability": {},
"exclusiveLiveChat": false,
"locked": false,
"wabaStatus": "xyz789",
"wabaError": "xyz789",
"wabaInfo": {},
"wabaIntegration": WABAIntegration,
"environment": ChannelEnvironment,
"environments": [ChannelEnvironment],
"incomingWebhooks": [ChannelIncomingWebhook],
"archived": false,
"archivedAt": {},
"connected": true
}
ChannelBroadcastGroup
Fields
| Field Name | Description |
|---|---|
label - String | |
groups - [BroadcastGroup] |
Example
{
"label": "xyz789",
"groups": [BroadcastGroup]
}
ChannelConnection
Fields
| Field Name | Description |
|---|---|
edges - [ChannelEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [ChannelEdge],
"pageInfo": PageInfo
}
ChannelEdge
ChannelEnvironment
Fields
| Field Name | Description |
|---|---|
envId - ID! | scope ["api:admin", "channel:getBasicInfo", "channel:getEnvironmentInfo"] |
name - String! | scope ["api:admin", "channel:getBasicInfo", "channel:getEnvironmentInfo"] |
description - String | scope ["api:admin", "channel:getBasicInfo", "channel:getEnvironmentInfo"] |
webhooks - JSON | scope ["api:admin", "channel:getDetails"] |
webhooksV2 - [ChannelWebhookV2] | scope ["api:admin", "channel:getDetails"] |
on - Boolean | scope ["api:admin", "channel:getAvailabilities"] |
info - JSON | |
appIntegrationSignature - String | scope ["api:admin", "channel:getPlatformInfo"] |
availability - JSON | scope ["api:admin", "channel:getAvailabilities"] |
integration - AppIntegration | scope ["api:admin", "channel:getDetails"] |
integrationInstalled - Boolean | scope ["api:admin", "channel:getDetails"] |
group - PriorityGroup | scope ["api:admin", "channel:getDetails"] |
trees - [Tree] | scope ["api:admin", "channel:getTreeSettings"] |
treeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
globalNodes - [NodeObject] | scope ["api:admin", "channel:getTreeSettings"] |
globalNodeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
offTrees - [Tree] | scope ["api:admin", "channel:getTreeSettings"] |
offTreeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
offGlobalNodes - [NodeObject] | scope ["api:admin", "channel:getTreeSettings"] |
offGlobalNodeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
livechatTrees - [Tree] | scope ["api:admin", "channel:getTreeSettings"] |
livechatTreeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
livechatGlobalNodes - [NodeObject] | scope ["api:admin", "channel:getTreeSettings"] |
livechatGlobalNodeIds - [ID] | scope ["api:admin", "channel:getTreeSettings"] |
hooks - ChannelHooks | scope ["api:admin", "channel:getDetails"] |
coreVersion - String | scope ["api:admin", "channel:getTreeSettings"] |
meta - JSON | scope ["api:admin", "channel:getTreeSettings"] |
Example
{
"envId": 4,
"name": "abc123",
"description": "abc123",
"webhooks": {},
"webhooksV2": [ChannelWebhookV2],
"on": false,
"info": {},
"appIntegrationSignature": "abc123",
"availability": {},
"integration": AppIntegration,
"integrationInstalled": true,
"group": PriorityGroup,
"trees": [Tree],
"treeIds": ["4"],
"globalNodes": [NodeObject],
"globalNodeIds": [4],
"offTrees": [Tree],
"offTreeIds": [4],
"offGlobalNodes": [NodeObject],
"offGlobalNodeIds": ["4"],
"livechatTrees": [Tree],
"livechatTreeIds": [4],
"livechatGlobalNodes": [NodeObject],
"livechatGlobalNodeIds": [4],
"hooks": ChannelHooks,
"coreVersion": "xyz789",
"meta": {}
}
ChannelEnvironmentWebhookDetail
Fields
| Input Field | Description |
|---|---|
webhookId - ID | |
integrationId - String | |
alias - String | |
url - String! | Url to receive webhook |
memberExtraData - [MemberExtraData] | Array of member extra data to be put in webhook |
customHeadersData - [CustomHeadersData] |
Example
{
"webhookId": "4",
"integrationId": "xyz789",
"alias": "xyz789",
"url": "abc123",
"memberExtraData": [MemberExtraData],
"customHeadersData": [CustomHeadersData]
}
ChannelEnvironmentWebhooks
Fields
| Input Field | Description |
|---|---|
normalizedInbound - [ChannelEnvironmentWebhookDetail] | |
normalizedOutbound - [ChannelEnvironmentWebhookDetail] |
Example
{
"normalizedInbound": [ChannelEnvironmentWebhookDetail],
"normalizedOutbound": [ChannelEnvironmentWebhookDetail]
}
ChannelHooks
Fields
| Field Name | Description |
|---|---|
preCoreEntry - ChannelPreCoreEntryHooks | |
postCoreEntry - [HookFunction] | |
postCoreEntryIds - [ID] |
Example
{
"preCoreEntry": ChannelPreCoreEntryHooks,
"postCoreEntry": [HookFunction],
"postCoreEntryIds": ["4"]
}
ChannelHooksInput
Fields
| Input Field | Description |
|---|---|
preCoreEntry - ChannelPreCoreEntryHooksInput | |
postCoreEntry - [ID] |
Example
{
"preCoreEntry": ChannelPreCoreEntryHooksInput,
"postCoreEntry": ["4"]
}
ChannelIncomingWebhook
Example
{
"webhookId": "4",
"url": "abc123",
"disabled": false,
"alias": "xyz789",
"integrationId": "abc123",
"appIntegration": "4",
"locked": true
}
ChannelIncomingWebhookActionInput
Fields
| Input Field | Description |
|---|---|
webhookId - ID | Used by UPDATE and DELETE action |
action - String | CREATE Create new Incoming Webhooks UPDATE Update Incoming Webhooks using webhookId DELETE Delete Incoming Webhooks using webhookId UPSERT Create Incoming Webhooks if no non-appIntegration Incoming Webhooks exist, otherwise update all non-appIntegration Incoming Webhooks (when called using an appIntegration token, it will check for Incoming Webhook created by the appIntegration instead) PULL Delete all non-appIntegration Incoming Webhooks (when called using an appIntegration token, it will delete the Incoming Webhook created by the appIntegration instead) |
alias - String | |
disabled - Boolean |
Example
{
"webhookId": 4,
"action": "abc123",
"alias": "xyz789",
"disabled": false
}
ChannelPreCoreEntryHooks
Fields
| Field Name | Description |
|---|---|
syncHooks - [HookFunction] | |
syncHookIds - [ID] | |
asyncHooks - [HookFunction] | |
asyncHookIds - [ID] |
Example
{
"syncHooks": [HookFunction],
"syncHookIds": ["4"],
"asyncHooks": [HookFunction],
"asyncHookIds": ["4"]
}
ChannelPreCoreEntryHooksInput
ChannelPriorityGroup
Fields
| Field Name | Description |
|---|---|
group - PriorityGroup | |
trees - [Tree] | |
treeIds - [ID] | |
globalNodes - [NodeObject] | |
globalNodeIds - [ID] | |
groupTrees - [Tree] | |
groupTreeIds - [ID] | |
groupGlobalNodes - [NodeObject] | |
groupGlobalNodeIds - [ID] | |
offTrees - [Tree] | |
offTreeIds - [ID] | |
offGlobalNodes - [NodeObject] | |
offGlobalNodeIds - [ID] | |
livechatTrees - [Tree] | |
livechatTreeIds - [ID] | |
livechatGlobalNodes - [NodeObject] | |
livechatGlobalNodeIds - [ID] | |
coreVersion - String | |
meta - JSON | |
override - Boolean | |
overrideOn - Boolean |
Example
{
"group": PriorityGroup,
"trees": [Tree],
"treeIds": ["4"],
"globalNodes": [NodeObject],
"globalNodeIds": ["4"],
"groupTrees": [Tree],
"groupTreeIds": ["4"],
"groupGlobalNodes": [NodeObject],
"groupGlobalNodeIds": [4],
"offTrees": [Tree],
"offTreeIds": ["4"],
"offGlobalNodes": [NodeObject],
"offGlobalNodeIds": [4],
"livechatTrees": [Tree],
"livechatTreeIds": [4],
"livechatGlobalNodes": [NodeObject],
"livechatGlobalNodeIds": ["4"],
"coreVersion": "xyz789",
"meta": {},
"override": false,
"overrideOn": false
}
ChannelWebhookV2
Example
{
"webhookId": "4",
"url": "xyz789",
"events": ["INBOUND"],
"memberExtraData": {},
"customHeadersData": {},
"alias": "abc123",
"integrationId": "abc123",
"locked": false
}
ChannelWebhookV2ActionInput
Fields
| Input Field | Description |
|---|---|
webhookId - ID | Used by UPDATE and DELETE action |
action - String | CREATE Create new webhooksV2 UPDATE Update webhooksV2 using webhookId DELETE Delete webhooksV2 using webhookId UPSERT Create webhooksV2 if webhooksV2 with matching url and events does not exist, otherwise update the matching webhooksV2's memberExtraData and customHeadersData PULL Delete webhooksV2 that has matching url and events |
url - String | |
alias - String | |
events - [WebhookEventType] | |
memberExtraData - [MemberExtraData] | |
customHeadersData - [CustomHeadersData] |
Example
{
"webhookId": 4,
"action": "xyz789",
"url": "abc123",
"alias": "xyz789",
"events": ["INBOUND"],
"memberExtraData": [MemberExtraData],
"customHeadersData": [CustomHeadersData]
}
ChannelWebhookV2Input
Fields
| Input Field | Description |
|---|---|
webhookId - ID | |
url - String | |
alias - String | |
events - [WebhookEventType] | |
memberExtraData - [MemberExtraData] | |
customHeadersData - [CustomHeadersData] |
Example
{
"webhookId": 4,
"url": "xyz789",
"alias": "abc123",
"events": ["INBOUND"],
"memberExtraData": [MemberExtraData],
"customHeadersData": [CustomHeadersData]
}
Chat
Fields
| Field Name | Description |
|---|---|
id - ID! | |
_id - ID! | |
createdAt - Long! | |
updatedAt - Long | |
sentAt - Long | |
readAt - Long | |
deliveredAt - Long | |
deletedAt - Long | |
group - Group | No longer supported |
assignment - Assignment | No longer supported |
messageEvent - JSON | |
from - ChatSender | |
member - Member | |
memberId - ID | |
admin - Admin | |
errors - JSON | |
failedAt - String | |
platform - String | |
channel - Channel | |
channelId - ID | |
app - App | |
appId - ID | |
tags - [String] | |
meta - JSON | |
etag - ID | |
isMultipleParty - Boolean |
Example
{
"id": "4",
"_id": 4,
"createdAt": {},
"updatedAt": {},
"sentAt": {},
"readAt": {},
"deliveredAt": {},
"deletedAt": {},
"group": Group,
"assignment": Assignment,
"messageEvent": {},
"from": "BOT",
"member": Member,
"memberId": 4,
"admin": Admin,
"errors": {},
"failedAt": "abc123",
"platform": "abc123",
"channel": Channel,
"channelId": 4,
"app": App,
"appId": "4",
"tags": ["xyz789"],
"meta": {},
"etag": 4,
"isMultipleParty": false
}
ChatConnection
Fields
| Field Name | Description |
|---|---|
edges - [ChatEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [ChatEdge],
"pageInfo": PageInfo
}
ChatEdge
ChatInput
Fields
| Input Field | Description |
|---|---|
externalId - ID | external Id |
memberId - ID | Member Id |
channelId - ID! | Channel Id |
from - ChatSender! | Message from MEMBER or BOT |
platform - String! | Channel platform type (integration id) |
sentAt - Long | Sent time |
deliveredAt - Long | Delivered time |
failedAt - Long | Failed time |
messageEvent - JSON | Message event |
woztellPushId - ID | Woztell Push Id |
error - Error | Failed error |
meta - JSON |
Example
{
"externalId": 4,
"memberId": "4",
"channelId": 4,
"from": "BOT",
"platform": "xyz789",
"sentAt": {},
"deliveredAt": {},
"failedAt": {},
"messageEvent": {},
"woztellPushId": "4",
"error": Error,
"meta": {}
}
ChatSender
Values
| Enum Value | Description |
|---|---|
|
| |
|
| |
|
| |
|
|
Example
"BOT"
Condition
Example
{
"id": 4,
"_id": 4,
"createdAt": {},
"updatedAt": {},
"name": "xyz789",
"description": "xyz789",
"functionString": "xyz789",
"app": App,
"system": true,
"systemKey": "abc123",
"autogen": true,
"etag": "4",
"history": [{}],
"tags": ["abc123"]
}
ConditionConnection
Fields
| Field Name | Description |
|---|---|
edges - [ConditionEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [ConditionEdge],
"pageInfo": PageInfo
}
ConditionEdge
Coordinates
CoordinatesInput
CreateActionInput
CreateActionPayload
CreateAgendaInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
member - ID | |
tree - ID | |
nodeCompositeId - ID | |
nextRunAt - Long | |
completed - Boolean | |
lastRunAt - Long | |
pattern - String | |
runUntil - Long | |
type - String | |
channel - ID | |
priority - Int | |
subscriptionPush - AgendaSubscriptionPushConfigInput | |
replace - Boolean | |
tag - String | |
meta - JSON | |
clientMutationId - ID |
Example
{
"app": 4,
"member": "4",
"tree": "4",
"nodeCompositeId": "4",
"nextRunAt": {},
"completed": true,
"lastRunAt": {},
"pattern": "abc123",
"runUntil": {},
"type": "xyz789",
"channel": 4,
"priority": 123,
"subscriptionPush": AgendaSubscriptionPushConfigInput,
"replace": false,
"tag": "xyz789",
"meta": {},
"clientMutationId": "4"
}
CreateAgendaPayload
CreateAudienceInput
Example
{
"name": "xyz789",
"description": "xyz789",
"app": "4",
"filter": AudienceFilterInput,
"channel": 4,
"tags": ["abc123"],
"clientMutationId": "4"
}
CreateAudiencePayload
CreateChannelEnvironmentInput
Example
{
"channelId": "4",
"name": "abc123",
"app": 4,
"build": 987,
"clientMutationId": 4
}
CreateChannelInput
CreateChannelPayload
Fields
| Field Name | Description |
|---|---|
channel - Channel | |
error - GenericError | |
clientMutationId - ID |
Example
{
"channel": Channel,
"error": GenericError,
"clientMutationId": 4
}
CreateConditionInput
Example
{
"name": "xyz789",
"description": "xyz789",
"functionString": "xyz789",
"app": "4",
"autogen": false,
"tags": ["abc123"],
"clientMutationId": "4"
}
CreateConditionPayload
CreateDataSourceDocInput
Description
Input type for creating datasource doc.
Example
{
"app": 4,
"collectionName": "xyz789",
"data": {},
"clientMutationId": "4"
}
CreateDataSourceDocPayload
CreateDataSourceInput
CreateDataSourcePayload
Description
Return type for creating datasource.
Fields
| Field Name | Description |
|---|---|
dataSource - DataSource | Datasource that created. |
clientMutationId - ID |
Example
{"dataSource": DataSource, "clientMutationId": 4}
CreateLocaleGroupInput
CreateLocaleGroupPayload
Fields
| Field Name | Description |
|---|---|
localeGroup - LocaleGroup | |
clientMutationId - ID |
Example
{
"localeGroup": LocaleGroup,
"clientMutationId": "4"
}
CreateMemberInput
Fields
| Input Field | Description |
|---|---|
app - ID | |
channel - ID! | |
platform - String! | |
profile - JSON | |
tags - [String] | |
meta - JSON | |
botMeta - BotMetaInput | |
externalId - ID | |
botId - ID | |
admin - ID | |
group - ID | |
fbId - ID | |
firstName - String | |
lastName - String | |
profilePic - String | |
gender - String | |
locale - String | |
customLocale - String | |
email - String | |
profilePicString - String | |
clientMutationId - ID |
Example
{
"app": "4",
"channel": "4",
"platform": "xyz789",
"profile": {},
"tags": ["xyz789"],
"meta": {},
"botMeta": BotMetaInput,
"externalId": "4",
"botId": 4,
"admin": "4",
"group": "4",
"fbId": 4,
"firstName": "xyz789",
"lastName": "abc123",
"profilePic": "abc123",
"gender": "abc123",
"locale": "abc123",
"customLocale": "xyz789",
"email": "abc123",
"profilePicString": "xyz789",
"clientMutationId": 4
}
CreateMemberPayload
CreateNodeInput
Fields
| Input Field | Description |
|---|---|
name - String! | |
description - String | |
trigger - ID | |
preActions - [ID] | |
responses - [ID] | |
postActions - [ID] | |
actions - [ID] | |
priority - Int | |
colour - String | |
path - String | |
app - ID | |
compositeId - ID | |
tree - ID! | |
global - Boolean! | |
redirect - RedirectInput | |
analytics - AnalyticsInput | |
memberTagging - MemberTaggingInput | |
type - NodeObjectType | |
dialogflow - DialogflowSettingsInput | |
luis - LuisSettingsInput | |
tags - [String] | |
clientMutationId - ID | |
saveCompositeId - Boolean |
Example
{
"name": "xyz789",
"description": "xyz789",
"trigger": 4,
"preActions": [4],
"responses": ["4"],
"postActions": ["4"],
"actions": [4],
"priority": 123,
"colour": "xyz789",
"path": "abc123",
"app": 4,
"compositeId": "4",
"tree": "4",
"global": false,
"redirect": RedirectInput,
"analytics": AnalyticsInput,
"memberTagging": MemberTaggingInput,
"type": "GENERAL",
"dialogflow": DialogflowSettingsInput,
"luis": LuisSettingsInput,
"tags": ["xyz789"],
"clientMutationId": 4,
"saveCompositeId": false
}
CreateNodePayload
Fields
| Field Name | Description |
|---|---|
node - NodeObject | |
clientMutationId - ID |
Example
{
"node": NodeObject,
"clientMutationId": "4"
}
CreateNotificationInput
Fields
| Input Field | Description |
|---|---|
appId - ID | |
notificationCode - String | A unique identifiable string for the notification for debounced deduplication. Must be used together with When both the |
timer - Long | Duration in ms for debounced deduplication (e.g. 1s = 1000). Must be used together with When both the |
color - String | |
title - String | |
status - String | |
message - String | |
buttons - [NotificationButtonInput] | |
linkTo - String | |
publish - Boolean | Defaults true. If publish is false, a silent notification will be sent. |
sendEmail - Boolean | Defaults The content of the email can be override by specifying the |
emailDetail - JSON | Accepts JSON object { from, to, cc, bcc, subject, text, html, attachments, amp } |
clientMutationId - ID |
Example
{
"appId": 4,
"notificationCode": "abc123",
"timer": {},
"color": "xyz789",
"title": "xyz789",
"status": "xyz789",
"message": "abc123",
"buttons": [NotificationButtonInput],
"linkTo": "abc123",
"publish": true,
"sendEmail": false,
"emailDetail": {},
"clientMutationId": 4
}
CreateNotificationPayload
Fields
| Field Name | Description |
|---|---|
notification - Notification | |
clientMutationId - ID |
Example
{
"notification": Notification,
"clientMutationId": "4"
}
CreatePriorityGroupInput
CreatePriorityGroupPayload
Fields
| Field Name | Description |
|---|---|
priorityGroup - PriorityGroup | |
clientMutationId - ID |
Example
{"priorityGroup": PriorityGroup, "clientMutationId": 4}
CreateResponseInput
Example
{
"name": "xyz789",
"description": "xyz789",
"app": 4,
"localeGroups": [ResponseLocaleGroupInput],
"tags": ["xyz789"],
"clientMutationId": 4
}
CreateResponsePayload
CreateRetryAudienceInput
CreateRetryAudiencePayload
Fields
| Field Name | Description |
|---|---|
audiences - [Audience] | |
clientMutationId - ID |
Example
{"audiences": [Audience], "clientMutationId": 4}
CreateSubscriptionPushInput
Fields
| Input Field | Description |
|---|---|
name - String | |
description - String | |
messages - JSON | Example: "messages" : [{ "platforms" : [{ "integrationId" : "woztell-essential-pack", "build" : 1, "localeGroups" : [{ "localeGroup" : "default", "variations" : [{ "name" : "Standard", "responses" : [{ "type" : "TEXT", "text" : "Hello World", "id" : "EQeUe7ZA", "transform" : "" }] }] }] }] }] |
app - ID | |
tags - [String] | |
agendaMeta - JSON | |
includeAudiences - [ID] | |
excludeAudiences - [ID] | |
fbMessageTag - String | |
filter - AudienceFilterInput | |
members - [ID] | |
fbOTNTags - [String] | |
parentSubscriptionPush - ID | |
scheduleAt - Long | |
priority - Int | |
clientMutationId - ID |
Example
{
"name": "abc123",
"description": "xyz789",
"messages": {},
"app": 4,
"tags": ["xyz789"],
"agendaMeta": {},
"includeAudiences": [4],
"excludeAudiences": ["4"],
"fbMessageTag": "abc123",
"filter": AudienceFilterInput,
"members": [4],
"fbOTNTags": ["abc123"],
"parentSubscriptionPush": 4,
"scheduleAt": {},
"priority": 987,
"clientMutationId": "4"
}
CreateSubscriptionPushPayload
Fields
| Field Name | Description |
|---|---|
subscriptionPush - SubscriptionPush | |
clientMutationId - ID |
Example
{
"subscriptionPush": SubscriptionPush,
"clientMutationId": 4
}
CreateTreeInput
Fields
| Input Field | Description |
|---|---|
name - String! | |
description - String | |
app - ID | |
globalNodes - [ID] | |
nodes - [ID] | |
workspace - [WorkspaceInput] | |
version - Int | |
versionAlias - String | |
ancestorTree - ID | |
stash - [ID] | |
tags - [String] | |
configMapSchema - JSON | |
configMap - JSON | |
type - String | |
templateTreeId - ID | |
system - Boolean | |
clientMutationId - ID |
Example
{
"name": "abc123",
"description": "xyz789",
"app": 4,
"globalNodes": [4],
"nodes": ["4"],
"workspace": [WorkspaceInput],
"version": 987,
"versionAlias": "xyz789",
"ancestorTree": "4",
"stash": [4],
"tags": ["abc123"],
"configMapSchema": {},
"configMap": {},
"type": "xyz789",
"templateTreeId": 4,
"system": true,
"clientMutationId": 4
}
CreateTreePayload
CreateTriggerInput
CreateTriggerPayload
CreateWhatsAppMessageTemplateInput
Fields
| Input Field | Description |
|---|---|
name - String! | WhatsApp Template Name |
category - String! | WhatsApp Template category |
channelId - ID | Stella Channel ID |
components - JSON! | WhatsApp Template Components |
language - String! | WhatsApp Template language |
wabaId - ID | WhatsApp Business Account ID |
clientMutationId - ID | ID generated by relay client for tracking the progress |
Example
{
"name": "abc123",
"category": "abc123",
"channelId": "4",
"components": {},
"language": "xyz789",
"wabaId": 4,
"clientMutationId": 4
}
CreateWhatsAppMessageTemplatePayload
CustomAction
Fields
| Field Name | Description |
|---|---|
title - String! | |
description - String | |
type - InboxIntegrationCustomActionType! | |
modalView - String | |
modalSchema - JSON | |
url - String | |
method - String | |
headers - JSON | |
body - JSON | |
api - String | No longer supported |
customHeaders - JSON | No longer supported |
customBody - JSON | No longer supported |
Example
{
"title": "xyz789",
"description": "xyz789",
"type": "MODAL",
"modalView": "xyz789",
"modalSchema": {},
"url": "xyz789",
"method": "xyz789",
"headers": {},
"body": {},
"api": "xyz789",
"customHeaders": {},
"customBody": {}
}
CustomHeadersData
DOB
DOBInput
DailyActiveMemberOverviewPayload
Fields
| Field Name | Description |
|---|---|
data - [DailyActiveMemberRow] | |
pageInfo - PageInfo |
Example
{
"data": [DailyActiveMemberRow],
"pageInfo": PageInfo
}
DailyActiveMemberRow
Example
{
"app": App,
"appId": "4",
"bucket": {},
"total_messageEvent": {},
"no_of_distinct_member_total": {},
"message_messageEvent": {},
"no_of_distinct_member_messages": {},
"comment_messageEvent": {},
"no_of_distinct_member_comment": {}
}
DataSource
Example
{
"name": "xyz789",
"description": "xyz789",
"collectionName": "xyz789",
"shopifyIntegration": "xyz789",
"data": DataSourceConnection,
"dataByQuery": {}
}
DataSourceConnection
Fields
| Field Name | Description |
|---|---|
edges - [DataSourceEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [DataSourceEdge],
"pageInfo": PageInfo
}
DataSourceData
Fields
| Field Name | Description |
|---|---|
data - JSON |
Example
{"data": {}}
DataSourceEdge
Fields
| Field Name | Description |
|---|---|
node - DataSourceData | |
cursor - ID |
Example
{"node": DataSourceData, "cursor": 4}
DeleteActionInput
DeleteActionPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
DeleteAgendaInput
DeleteAgendaPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
DeleteAudienceInput
DeleteAudiencePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
DeleteChannelEnvironmentInput
DeleteChannelEnvironmentPayload
Fields
| Field Name | Description |
|---|---|
channel - Channel | |
forceRequest - Boolean | |
error - GenericError | |
clientMutationId - ID |
Example
{
"channel": Channel,
"forceRequest": true,
"error": GenericError,
"clientMutationId": 4
}
DeleteChannelInput
DeleteChannelPayload
Fields
| Field Name | Description |
|---|---|
error - GenericError | |
forceRequest - Boolean | |
errorMessage - String | |
errors - [endpointError] | |
clientMutationId - ID |
Example
{
"error": GenericError,
"forceRequest": true,
"errorMessage": "xyz789",
"errors": [endpointError],
"clientMutationId": "4"
}
DeleteConditionInput
DeleteConditionPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
DeleteDataSourceDocsInput
Description
Input type for deleting datasource doc.
Example
{
"app": "4",
"collectionName": "abc123",
"dataIds": [4],
"deleteAll": true,
"clientMutationId": "4"
}
DeleteDataSourceDocsPayload
Description
Return type for deleting datasource doc.
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
DeleteDataSourceInput
DeleteDataSourcePayload
Description
Return type for deleting datasource.
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteLocaleGroupInput
DeleteLocaleGroupPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteMemberInput
DeleteMemberPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
DeleteMembersInput
Fields
| Input Field | Description |
|---|---|
criteria - JSON | Criteria is an array of object that is translated to a member filter. Small Example: [{ "field" : "externalId", "operator" : "equal", "value" : "123" },{ "field" : "channel", "operator" : "equal", "value" : "abc" }] "criteria options": "field": "_id" | "tags" | "fbOTNTag", "filters": [{ "operator": "in" | "nin", "value": ["ID | String"]}] "field": "createdAt" | "updatedAt", "from": "epoch number", "to": "epoch number" "field": "firstName" | "lastName", "value": "String" "field": "liveChat", "value": "Boolean" "operator": "equal" | "in" | "nin" | "ne" | "regex" ("eq" does not work) "field": "String", (as long as field is not one of the aboves, example: "externalId", "channel", "locale", "gender", "botMeta.tempData.abc", "meta.def") "value": "Any" |
createdAtFrom - Long | |
createdAtTo - Long | |
updatedAtFrom - Long | |
updatedAtTo - Long | |
clientMutationId - ID |
Example
{
"criteria": {},
"createdAtFrom": {},
"createdAtTo": {},
"updatedAtFrom": {},
"updatedAtTo": {},
"clientMutationId": 4
}
DeleteMembersPayload
Fields
| Field Name | Description |
|---|---|
backgroundTask - BackgroundTask | |
error - GenericError | |
clientMutationId - ID |
Example
{
"backgroundTask": BackgroundTask,
"error": GenericError,
"clientMutationId": 4
}
DeleteNodeInput
DeleteNodePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - String |
Example
{"clientMutationId": "abc123"}
DeletePriorityGroupInput
DeletePriorityGroupPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
DeleteResponseInput
DeleteResponsePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteSubscriptionPushInput
DeleteSubscriptionPushPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteTreeInput
DeleteTreePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DeleteTriggerInput
DeleteTriggerPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": "4"}
DeleteWhatsAppMessageTemplateInput
Example
{
"channelId": "4",
"name": "xyz789",
"wabaId": 4,
"clientMutationId": 4
}
DeleteWhatsAppMessageTemplatePayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID |
Example
{"clientMutationId": 4}
DialogflowSettings
DialogflowSettingsInput
DuplicateTreeInput
DuplicateTreePayload
EmailCred
EmailInput
Error
ExportChatsInput
Example
{
"memberId": "xyz789",
"from": {},
"to": {},
"group": 4,
"assignment": "4",
"showHidden": true,
"key": "abc123",
"folder": "xyz789",
"timeZone": 987
}
ExportChatsPayload
ExportTreesInput
Fields
| Input Field | Description |
|---|---|
trees - [String!]! |
Example
{"trees": ["xyz789"]}
ExportTreesPayload
Example
{
"url": "xyz789",
"trees": [{}],
"nodes": [{}],
"triggers": [{}],
"conditions": [{}],
"actions": [{}],
"responses": [{}],
"localeGroups": [{}]
}
FbOTNToken
FindAndModifyDataSourceDocInput
Description
Input type for find and modify datasource doc.
Fields
| Input Field | Description |
|---|---|
collectionName - ID! | Datasource id in Stella. |
filter - JSON | MongoDB filter apply to filter doc from datasource. |
patch - JSON | MongoDB patch option to update docs in datasource |
options - JSON | MongoDB options in find and modify docs in datasource |
sortBy - JSON | MongoDB sorting the filter result to modify docs in datasource |
clientMutationId - ID |
Example
{
"collectionName": "4",
"filter": {},
"patch": {},
"options": {},
"sortBy": {},
"clientMutationId": 4
}
FindAndModifyDataSourceDocPayload
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
GenericError
Group
Fields
| Field Name | Description |
|---|---|
id - ID! | |
_id - ID! | |
createdAt - Long! | |
updatedAt - Long | |
inlet - Channel | |
inletId - ID | |
outlet - Channel | |
outletId - ID | |
assignment - Assignment! | |
assignmentId - ID | |
member - Member | |
memberId - ID | |
admin - Admin! | |
adminMember - Member | |
name - String | |
description - String | |
icon - String | |
meta - JSON | |
valid - Boolean | |
externalId - String | |
inletGroupExternalId - ID | |
botId - String | |
type - String | |
adminExternalId - ID | |
app - App! | |
active - Boolean | |
tags - [String] | |
etag - ID |
Example
{
"id": "4",
"_id": "4",
"createdAt": {},
"updatedAt": {},
"inlet": Channel,
"inletId": "4",
"outlet": Channel,
"outletId": 4,
"assignment": Assignment,
"assignmentId": "4",
"member": Member,
"memberId": "4",
"admin": Admin,
"adminMember": Member,
"name": "abc123",
"description": "xyz789",
"icon": "abc123",
"meta": {},
"valid": false,
"externalId": "abc123",
"inletGroupExternalId": "4",
"botId": "xyz789",
"type": "xyz789",
"adminExternalId": "4",
"app": App,
"active": true,
"tags": ["xyz789"],
"etag": "4"
}
GroupConnection
Fields
| Field Name | Description |
|---|---|
edges - [GroupEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [GroupEdge],
"pageInfo": PageInfo
}
GroupEdge
Hook
Fields
| Field Name | Description |
|---|---|
preCoreEntry - HookFunction | |
postCoreEntry - HookFunction |
Example
{
"preCoreEntry": HookFunction,
"postCoreEntry": HookFunction
}
HookFunction
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
ImportDataSourceInput
Description
Input type for importing datasource doc.
Fields
| Input Field | Description |
|---|---|
app - ID | App ID in Stella. |
data - [JSON] | The data(s) to import into datasource |
collectionName - String! | Datasource id in Stella. |
url - String | Data download Url |
format - String | Format of remote file, only accept json or csv |
downloadHeader - JSON | Header for requesting remote file |
parseJSON - Boolean | Only applied to remote csv file for parsing the JSON or not |
action - String! | Import action, only accept APPEND or REPLACE. |
clientMutationId - ID |
Example
{
"app": "4",
"data": [{}],
"collectionName": "abc123",
"url": "abc123",
"format": "abc123",
"downloadHeader": {},
"parseJSON": false,
"action": "xyz789",
"clientMutationId": 4
}
ImportDataSourcePayload
ImportMembersInput
Example
{
"url": "abc123",
"mapping": {},
"channelId": 4,
"platform": "abc123",
"delimiter": "abc123",
"tags": ["abc123"],
"app": "4",
"clientMutationId": 4
}
ImportMembersPayload
Fields
| Field Name | Description |
|---|---|
clientMutationId - ID | |
backgroundTask - BackgroundTask |
Example
{"clientMutationId": 4, "backgroundTask": BackgroundTask}
ImportTreesInput
Fields
| Input Field | Description |
|---|---|
trees - [JSON] | |
nodes - [JSON] | |
triggers - [JSON] | |
conditions - [JSON] | |
actions - [JSON] | |
responses - [JSON] | |
localeGroups - [JSON] | |
prefix - String | |
force - Boolean | |
forceKeepResponsePlatforms - [String] | List of Platforms to keep the response. Ex: ["facebook", "whatsapp-cloud"] Note that force must be true for this to work correctly. |
app - ID | |
url - String |
Example
{
"trees": [{}],
"nodes": [{}],
"triggers": [{}],
"conditions": [{}],
"actions": [{}],
"responses": [{}],
"localeGroups": [{}],
"prefix": "abc123",
"force": true,
"forceKeepResponsePlatforms": ["xyz789"],
"app": "4",
"url": "abc123"
}
ImportTreesPayload
Fields
| Field Name | Description |
|---|---|
trees - [Tree] | |
uninstalledIntegrations - [UninstalledIntegration] |
Example
{
"trees": [Tree],
"uninstalledIntegrations": [UninstalledIntegration]
}
InboxIntegration
Fields
| Field Name | Description |
|---|---|
inputActions - [CustomAction] | |
messageActions - [CustomAction] | |
folderActions - [CustomAction] |
Example
{
"inputActions": [CustomAction],
"messageActions": [CustomAction],
"folderActions": [CustomAction]
}
InboxIntegrationCustomActionType
Values
| Enum Value | Description |
|---|---|
|
| |
|
| |
|
| No longer supported |
Example
"MODAL"
InboxMemberProfile
Example
{
"firstName": "xyz789",
"lastName": "abc123",
"middleName": "abc123",
"name": "xyz789",
"title": "xyz789",
"phones": [Phone],
"emails": [ProfileEmail],
"gender": "xyz789",
"dob": DOB,
"addresses": [Address],
"profilePicUrl": "xyz789",
"locale": "xyz789"
}
InboxMemberProfileInput
Fields
| Input Field | Description |
|---|---|
firstName - String | |
lastName - String | |
middleName - String | |
name - String | |
title - String | |
phones - [PhoneInput] | |
emails - [EmailInput] | |
gender - String | |
dob - DOBInput | |
addresses - [AddressInput] | |
profilePicUrl - String | |
locale - String |
Example
{
"firstName": "abc123",
"lastName": "xyz789",
"middleName": "xyz789",
"name": "xyz789",
"title": "abc123",
"phones": [PhoneInput],
"emails": [EmailInput],
"gender": "xyz789",
"dob": DOBInput,
"addresses": [AddressInput],
"profilePicUrl": "xyz789",
"locale": "xyz789"
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
IntMax100
Description
minimum 0, maximum 100
Example
IntMax100
IntegrationEndpoints
Example
{
"install": "abc123",
"preUpdate": "xyz789",
"postUpdate": "abc123",
"uninstall": "abc123",
"channelCreate": "abc123",
"channelDelete": "xyz789",
"channelResubscribe": "abc123",
"channelUnsubscribe": "abc123",
"memberDelete": "xyz789",
"messageSend": "abc123",
"ticketCreate": "xyz789",
"ticketInactivate": "abc123"
}
IntegrationTree
IntegrationView
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
LiveChatAgenda
LocaleGroup
LocaleGroupConnection
Fields
| Field Name | Description |
|---|---|
edges - [LocaleGroupEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [LocaleGroupEdge],
"pageInfo": PageInfo
}
LocaleGroupEdge
Fields
| Field Name | Description |
|---|---|
node - LocaleGroup | |
cursor - ID! |
Example
{
"node": LocaleGroup,
"cursor": "4"
}
Long
Description
Long Integer type
Example
{}
LuisSettings
LuisSettingsInput
ManagedApp
Member
Fields
| Field Name | Description |
|---|---|
id - ID! | |
_id - ID! | |
createdAt - Long! | |
updatedAt - Long | |
app - App! | |
appId - ID! | |
channel - Channel | |
channelId - ID | |
platform - String! | |
profile - MemberProfile | |
inboxProfile - InboxMemberProfile | |
tags - [String] | |
meta - JSON | |
botMeta - BotMeta | |
externalId - ID | |
botId - ID | |
admin - Admin | |
adminId - ID | |
group - Group | No longer supported |
assignment - ID | No longer supported |
fbId - ID | |
name - String | |
firstName - String | |
lastName - String | |
profilePic - String | |
gender - String | |
customLocale - String | |
locale - String | |
email - String | |
profilePicString - String | |
inletGroup - Boolean | |
fbOTNTokens - [FbOTNToken] | |
notes - [Note] | Free-text notes that the agent can add to the member |
etag - ID |
Example
{
"id": "4",
"_id": "4",
"createdAt": {},
"updatedAt": {},
"app": App,
"appId": "4",
"channel": Channel,
"channelId": "4",
"platform": "xyz789",
"profile": MemberProfile,
"inboxProfile": InboxMemberProfile,
"tags": ["xyz789"],
"meta": {},
"botMeta": BotMeta,
"externalId": "4",
"botId": "4",
"admin": Admin,
"adminId": "4",
"group": Group,
"assignment": "4",
"fbId": 4,
"name": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"profilePic": "abc123",
"gender": "xyz789",
"customLocale": "xyz789",
"locale": "abc123",
"email": "xyz789",
"profilePicString": "abc123",
"inletGroup": false,
"fbOTNTokens": [FbOTNToken],
"notes": [Note],
"etag": "4"
}
MemberConnection
Fields
| Field Name | Description |
|---|---|
edges - [MemberEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [MemberEdge],
"pageInfo": PageInfo
}
MemberEdge
MemberExtraData
Fields
| Input Field | Description |
|---|---|
field - String | Field name in webhook under memberExtra |
path - String | Path under member data. Ref: https://doc.woztell.com/docs/reference/member-reference |
Example
{
"field": "xyz789",
"path": "abc123"
}
MemberProfile
Fields
| Field Name | Description |
|---|---|
id - String | |
first_name - String | |
last_name - String | |
username - String | |
profile_pic - String | |
timezone - Int | |
displayName - String | |
profilePic - String | |
tbId - Int | |
real_name - String | |
display_name - String | |
avatar_hash - String | |
status_text - String | |
status_emoji - String | |
team - String | |
image_24 - String | |
image_32 - String | |
image_48 - String | |
image_72 - String | |
image_192 - String | |
image_512 - String | |
image_1024 - String | |
image_original - String | |
real_name_normalized - String | |
display_name_normalized - String | |
email - String | |
fields - JSON | |
is_bot - Boolean | |
language_code - String | |
subscribe - Int | |
openid - String | |
nickname - String | |
sex - Int | |
language - String | |
city - String | |
province - String | |
country - String | |
headimgurl - String | |
subscribe_time - Long | |
remark - String | |
groupid - Int | |
tagid_list - [Int] | |
subscribe_scene - String | |
qr_scene - Int | |
qr_scene_str - String | |
firstName - String | |
lastName - String | |
middleName - String | |
name - String | |
title - String | |
phones - [Phone] | |
emails - [ProfileEmail] | |
gender - String | |
dob - DOB | |
addresses - [Address] | |
profilePicUrl - String | |
locale - String |
Example
{
"id": "xyz789",
"first_name": "abc123",
"last_name": "abc123",
"username": "abc123",
"profile_pic": "xyz789",
"timezone": 123,
"displayName": "abc123",
"profilePic": "xyz789",
"tbId": 123,
"real_name": "abc123",
"display_name": "xyz789",
"avatar_hash": "abc123",
"status_text": "abc123",
"status_emoji": "xyz789",
"team": "abc123",
"image_24": "xyz789",
"image_32": "abc123",
"image_48": "xyz789",
"image_72": "abc123",
"image_192": "abc123",
"image_512": "abc123",
"image_1024": "xyz789",
"image_original": "abc123",
"real_name_normalized": "abc123",
"display_name_normalized": "xyz789",
"email": "abc123",
"fields": {},
"is_bot": true,
"language_code": "xyz789",
"subscribe": 123,
"openid": "abc123",
"nickname": "abc123",
"sex": 987,
"language": "xyz789",
"city": "abc123",
"province": "abc123",
"country": "abc123",
"headimgurl": "xyz789",
"subscribe_time": {},
"remark": "xyz789",
"groupid": 987,
"tagid_list": [123],
"subscribe_scene": "abc123",
"qr_scene": 987,
"qr_scene_str": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"middleName": "xyz789",
"name": "abc123",
"title": "xyz789",
"phones": [Phone],
"emails": [ProfileEmail],
"gender": "xyz789",
"dob": DOB,
"addresses": [Address],
"profilePicUrl": "xyz789",
"locale": "abc123"
}
MemberProfileInput
Fields
| Input Field | Description |
|---|---|
id - String | |
first_name - String | |
last_name - String | |
username - String | |
profile_pic - String | |
timezone - Int | |
displayName - String | |
profilePic - String | |
tbId - Int | |
real_name - String | |
display_name - String | |
avatar_hash - String | |
status_text - String | |
status_emoji - String | |
team - String | |
image_24 - String | |
image_32 - String | |
image_48 - String | |
image_72 - String | |
image_192 - String | |
image_512 - String | |
image_1024 - String | |
image_original - String | |
real_name_normalized - String | |
display_name_normalized - String | |
email - String | |
fields - JSON | |
is_bot - Boolean | |
language_code - String | |
subscribe - Int | |
openid - String | |
nickname - String | |
sex - Int | |
language - String | |
city - String | |
province - String | |
country - String | |
headimgurl - String | |
subscribe_time - Long | |
remark - String | |
groupid - Int | |
tagid_list - [Int] | |
subscribe_scene - String | |
qr_scene - Int | |
qr_scene_str - String | |
firstName - String | |
lastName - String | |
middleName - String | |
name - String | |
title - String | |
phones - [PhoneInput] | |
emails - [EmailInput] | |
gender - String | |
dob - DOBInput | |
addresses - [AddressInput] | |
profilePicUrl - String | |
locale - String |
Example
{
"id": "abc123",
"first_name": "abc123",
"last_name": "abc123",
"username": "abc123",
"profile_pic": "xyz789",
"timezone": 987,
"displayName": "xyz789",
"profilePic": "xyz789",
"tbId": 123,
"real_name": "xyz789",
"display_name": "xyz789",
"avatar_hash": "xyz789",
"status_text": "xyz789",
"status_emoji": "xyz789",
"team": "xyz789",
"image_24": "abc123",
"image_32": "abc123",
"image_48": "abc123",
"image_72": "abc123",
"image_192": "xyz789",
"image_512": "abc123",
"image_1024": "abc123",
"image_original": "abc123",
"real_name_normalized": "xyz789",
"display_name_normalized": "abc123",
"email": "abc123",
"fields": {},
"is_bot": true,
"language_code": "abc123",
"subscribe": 123,
"openid": "abc123",
"nickname": "xyz789",
"sex": 987,
"language": "abc123",
"city": "xyz789",
"province": "xyz789",
"country": "abc123",
"headimgurl": "xyz789",
"subscribe_time": {},
"remark": "xyz789",
"groupid": 987,
"tagid_list": [987],
"subscribe_scene": "abc123",
"qr_scene": 987,
"qr_scene_str": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"middleName": "abc123",
"name": "abc123",
"title": "abc123",
"phones": [PhoneInput],
"emails": [EmailInput],
"gender": "abc123",
"dob": DOBInput,
"addresses": [AddressInput],
"profilePicUrl": "abc123",
"locale": "xyz789"
}
MemberTagging
MemberTaggingInput
MergeMembersByExternalIdsInput
Fields
| Input Field | Description |
|---|---|
channel - ID | Channel ID for the two merging members |
priorExternalId - ID | The external ID of the member that should be replaced by the finalExternalId |
finalExternalId - ID | The external ID of the member that should overwrite the priorExternalId |
meta - JSON | A meta object to insert into the final member after the merge finishes |
app - ID | |
clientMutationId - ID |
Example
{
"channel": "4",
"priorExternalId": "4",
"finalExternalId": 4,
"meta": {},
"app": 4,
"clientMutationId": "4"
}
MergeMembersByExternalIdsPayload
Fields
| Field Name | Description |
|---|---|
member - Member | The final member after prior member is deleted |
action - String | The result of the merge. PriorMemberMergedToFinalMember: Both Prior Member and Final Member were found. Prior Member is deleted. Final Member receive the chats and priorityGroups of the Prior Member. Tree, Node and LiveChat status is copied from Prior Member as well. The meta input is also inserted to the Final Member. UpdatedPriorMemberWithFinalExternalId: Only Prior Member was found. Thus Prior Member has its externalId updated from priorExternalId to finalExternalId and also gets the meta input data. NoPriorMemberToMerge: Only Final Member was found. The meta input data is insert to the Final Member. PriorAndFinalMembersNotFound: Neither Members were found. No member is created or updated. |
clientMutationId - ID |
Example
{
"member": Member,
"action": "xyz789",
"clientMutationId": "4"
}
Message
Fields
| Field Name | Description |
|---|---|
localeGroups - [ResponseLocaleGroup] |
Example
{"localeGroups": [ResponseLocaleGroup]}
ModifyMemberTagsInput
Fields
| Input Field | Description |
|---|---|
memberId - ID | The identifier for the user. Used to filter to the correct user |
externalId - ID | Dangerous!!! May have same externalId under same app The external identifier for the user. Used to filter if memberId is missing |
appId - ID | The identifier for the app the user is using. Used to filter the appID |
tags - [String]! | Array of tags for adding / removing |
clientMutationId - ID | Client mutation id for relay |
Example
{
"memberId": 4,
"externalId": "4",
"appId": 4,
"tags": ["abc123"],
"clientMutationId": "4"
}
ModifyMemberTagsPayload
Fields
| Field Name | Description |
|---|---|
ok - Int | Used signify whether the action has succeed. Returning 1 for success, 0 for failure. |
err_code - Int | The error code. Returns the code of the error. |
err - String | The error message. Returns a string explaining what error has occurred. |
memberId - ID | ID of modified member |
member - Member | |
clientMutationId - ID | Client mutation id for relay |
Example
{
"ok": 123,
"err_code": 987,
"err": "xyz789",
"memberId": 4,
"member": Member,
"clientMutationId": "4"
}
MongoDBArrayOption
Values
| Enum Value | Description |
|---|---|
|
| |
|
| |
|
|
Example
"set"
NLPAnalyticsCounter
Example
{
"app": App,
"appId": 4,
"type": "abc123",
"agent_id": "abc123",
"intent_id": "abc123",
"intent_name": "xyz789",
"bucket": {},
"no_of_nlp_analytics": {},
"average_confidence_level": {}
}
NLPAnalyticsCounterConnection
Fields
| Field Name | Description |
|---|---|
edges - [NLPAnalyticsCounterEdge] | |
total_no_of_nlp_analytics - Long! | |
pageInfo - PageInfo |
Example
{
"edges": [NLPAnalyticsCounterEdge],
"total_no_of_nlp_analytics": {},
"pageInfo": PageInfo
}
NLPAnalyticsCounterEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - NLPAnalyticsCounter |
Example
{
"cursor": "4",
"node": NLPAnalyticsCounter
}
NewMemberCounter
NewMemberCounterConnection
Fields
| Field Name | Description |
|---|---|
data - [NewMemberCounter] | |
pageInfo - PageInfo | |
total_no_of_member - Long | |
total_no_of_comment_member - Long |
Example
{
"data": [NewMemberCounter],
"pageInfo": PageInfo,
"total_no_of_member": {},
"total_no_of_comment_member": {}
}
Node
Fields
| Field Name | Description |
|---|---|
id - ID! |
Example
{"id": "4"}
NodeObject
Fields
| Field Name | Description |
|---|---|
id - ID! | |
_id - ID! | |
createdAt - Long! | |
updatedAt - Long | |
name - String! | |
description - String | |
trigger - Trigger | |
triggerId - ID | |
preActions - [Action] | |
preActionIds - [ID] | |
responses - [Response] | |
responseIds - [ID] | |
postActions - [Action] | |
postActionIds - [ID] | |
actions - [Action] | |
actionIds - [ID] | |
priority - Float | |
path - String | |
app - App! | |
appId - ID | |
compositeId - ID | |
tree - Tree | |
treeId - ID | |
locked - Boolean | |
global - Boolean | |
redirect - Redirect | |
analytics - Analytics | |
memberTagging - MemberTagging | |
type - NodeObjectType | |
dialogflow - DialogflowSettings | |
luis - LuisSettings | |
etag - ID | |
history - [JSON] | |
colour - String | |
tags - [String] | |
templateTreeId - ID | |
saveCompositeId - Boolean |
Example
{
"id": 4,
"_id": 4,
"createdAt": {},
"updatedAt": {},
"name": "xyz789",
"description": "xyz789",
"trigger": Trigger,
"triggerId": "4",
"preActions": [Action],
"preActionIds": [4],
"responses": [Response],
"responseIds": ["4"],
"postActions": [Action],
"postActionIds": [4],
"actions": [Action],
"actionIds": ["4"],
"priority": 123.45,
"path": "abc123",
"app": App,
"appId": "4",
"compositeId": "4",
"tree": Tree,
"treeId": 4,
"locked": true,
"global": true,
"redirect": Redirect,
"analytics": Analytics,
"memberTagging": MemberTagging,
"type": "GENERAL",
"dialogflow": DialogflowSettings,
"luis": LuisSettings,
"etag": 4,
"history": [{}],
"colour": "abc123",
"tags": ["abc123"],
"templateTreeId": "4",
"saveCompositeId": true
}
NodeObjectConnection
Fields
| Field Name | Description |
|---|---|
edges - [NodeObjectEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [NodeObjectEdge],
"pageInfo": PageInfo
}
NodeObjectEdge
Fields
| Field Name | Description |
|---|---|
node - NodeObject | |
cursor - ID! |
Example
{"node": NodeObject, "cursor": 4}
NodeObjectType
Values
| Enum Value | Description |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Example
"GENERAL"
NormalIntegrationInput
Note
NoteInput
Notification
Fields
| Field Name | Description |
|---|---|
id - ID! | |
_id - ID! | |
createdAt - Long! | |
updatedAt - Long | |
app - App! | |
appId - ID | |
type - String | Type of notification for catorgorization. Possible values are BACKGROUND_TASK | INTEGRATION | API |
color - String | Color of the notification. Accepts HEX color code. |
title - String | Title of the notification. Max 80 characters. |
status - String | When status is specified, the color of the notification will be predefined and the status will be the title of the notification. So the status can be either "SUCCESS" / "RUNNING" / "PENDING" / "ERROR", which corresponding to different colors, green, blue, grey and red |
message - String | |
buttons - [NotificationButton] | Maximum 2 buttons are allowed. |
backgroundTaskId - ID | |
linkTo - String | A relative path to the Woztell Platform, so when user click on this notification, user will be directed to the page. |
new - Boolean | |
etag - ID |
Example
{
"id": 4,
"_id": 4,
"createdAt": {},
"updatedAt": {},
"app": App,
"appId": "4",
"type": "abc123",
"color": "abc123",
"title": "abc123",
"status": "abc123",
"message": "xyz789",
"buttons": [NotificationButton],
"backgroundTaskId": "4",
"linkTo": "xyz789",
"new": false,
"etag": 4
}
NotificationButton
Fields
| Field Name | Description |
|---|---|
text - String! | The title of the button |
path - String | A relative path to the Woztell Platform, so when user click on this button with path, user will be directed to the page. |
url - String | An absolute URL. When user click on this button, a new tab with this URL will be opened. |
Example
{
"text": "xyz789",
"path": "abc123",
"url": "abc123"
}
NotificationButtonInput
PageInfo
Pair
PairInput
Partner
Fields
| Field Name | Description |
|---|---|
id - ID! | |
_id - ID! | |
createdAt - Long! | |
updatedAt - Long | |
name - String! | |
info - JSON | |
meta - JSON | |
teamMembers - [TeamMember] | |
etag - ID | |
partnerTier - String | |
skipCC - Boolean | |
alias - String | |
managedApps - [ManagedApp] | |
managedAppsCount - Int | |
activated - Boolean | |
entEnabled - Boolean | |
Example
{
"id": 4,
"_id": 4,
"createdAt": {},
"updatedAt": {},
"name": "abc123",
"info": {},
"meta": {},
"teamMembers": [TeamMember],
"etag": "4",
"partnerTier": "abc123",
"skipCC": true,
"alias": "xyz789",
"managedApps": [ManagedApp],
"managedAppsCount": 123,
"activated": false,
"entEnabled": true
}
Phone
PhoneInput
PlatformCred
Fields
| Field Name | Description |
|---|---|
fbUserId - String |
Example
{"fbUserId": "abc123"}
PlatformIntegrationInput
PostCommentAnalyticsOverview
Example
{
"app": App,
"appId": "4",
"post_id": "xyz789",
"no_of_matched_comment": {},
"no_of_non_matched_comment": {},
"total_no_of_comment": {}
}
PostCommentAnalyticsOverviewConnection
Fields
| Field Name | Description |
|---|---|
edges - [PostCommentAnalyticsOverviewEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [PostCommentAnalyticsOverviewEdge],
"pageInfo": PageInfo
}
PostCommentAnalyticsOverviewEdge
Fields
| Field Name | Description |
|---|---|
cursor - ID! | |
node - PostCommentAnalyticsOverview |
Example
{"cursor": 4, "node": PostCommentAnalyticsOverview}
PriorityGroup
Example
{
"id": 4,
"_id": "4",
"createdAt": {},
"updatedAt": {},
"name": "abc123",
"description": "abc123",
"app": App,
"channel": Channel,
"members": [Member],
"memberIds": ["4"],
"tags": ["abc123"],
"etag": "4"
}
PriorityGroupConnection
Fields
| Field Name | Description |
|---|---|
edges - [PriorityGroupEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [PriorityGroupEdge],
"pageInfo": PageInfo
}
PriorityGroupEdge
Fields
| Field Name | Description |
|---|---|
node - PriorityGroup | |
cursor - ID! |
Example
{
"node": PriorityGroup,
"cursor": "4"
}
ProfileEmail
PullAppIntegrationInput
PullAppIntegrationPayload
Description
The return payload for PullAppIntegration. Used to delete an integration from the database.
Example
{
"ok": 123,
"err_code": 123,
"err": "abc123"
}
PutAppIntegrationInput
PutAppIntegrationPayload
Description
The return payload for PutAppIntegration. Used to put an integration to the database.
Fields
| Field Name | Description |
|---|---|
app - App | |
appId - ID | |
ok - Int | Used signify whether the action has succeed. Returning 1 for success, 0 for failure. |
err_code - Int | The error code. Returns the code of the error. |
err - String | The error message. Returns a string explaining what error has occurred. |
integrationId - ID | An ID of an integration. The ID for the newly put integration. |
clientMutationId - ID |
Example
{
"app": App,
"appId": 4,
"ok": 123,
"err_code": 123,
"err": "xyz789",
"integrationId": "4",
"clientMutationId": 4
}
Redirect
RedirectInput
RemoveNoteFromMemberInput
RemoveNoteFromMemberPayload
Fields
| Field Name | Description |
|---|---|
member - Member | |
error - GenericError | |
clientMutationId - ID |
Example
{
"member": Member,
"error": GenericError,
"clientMutationId": 4
}
ResourceTemplate
Fields
| Field Name | Description |
|---|---|
_id - ID! | |
id - ID! | |
createdAt - Long! | |
updatedAt - Long | |
etag - ID | |
schema - JSON | |
functionString - String | |
type - String | |
name - String! | |
description - String | |
integrationId - ID | |
build - Int | |
preview - String | |
alias - String | |
validatorFunctionString - String | |
requestedVerification - Boolean | |
verified - Boolean | |
published - Boolean | |
masked - Boolean | |
for - [String] |
Example
{
"_id": "4",
"id": 4,
"createdAt": {},
"updatedAt": {},
"etag": "4",
"schema": {},
"functionString": "xyz789",
"type": "abc123",
"name": "abc123",
"description": "xyz789",
"integrationId": "4",
"build": 987,
"preview": "xyz789",
"alias": "abc123",
"validatorFunctionString": "xyz789",
"requestedVerification": false,
"verified": false,
"published": true,
"masked": false,
"for": ["abc123"]
}
Response
Example
{
"id": 4,
"_id": "4",
"createdAt": {},
"updatedAt": {},
"name": "abc123",
"description": "abc123",
"app": App,
"localeGroups": [ResponseLocaleGroup],
"pickResponse": {},
"history": [{}],
"tags": ["abc123"],
"etag": "4"
}
ResponseConnection
Fields
| Field Name | Description |
|---|---|
edges - [ResponseEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [ResponseEdge],
"pageInfo": PageInfo
}
ResponseEdge
ResponseLocaleGroup
Fields
| Field Name | Description |
|---|---|
localeGroup - LocaleGroup | |
variations - [ResponseVariation] |
Example
{
"localeGroup": LocaleGroup,
"variations": [ResponseVariation]
}
ResponseLocaleGroupInput
Fields
| Input Field | Description |
|---|---|
localeGroup - ID! | |
variations - [ResponseVariationInput] |
Example
{
"localeGroup": "4",
"variations": [ResponseVariationInput]
}
ResponseObject
ResponseObjectInput
ResponseVariation
Fields
| Field Name | Description |
|---|---|
name - String! | |
platforms - [ResponseObject] |
Example
{
"name": "xyz789",
"platforms": [ResponseObject]
}
ResponseVariationInput
Fields
| Input Field | Description |
|---|---|
name - String! | |
platforms - [ResponseObjectInput] |
Example
{
"name": "xyz789",
"platforms": [ResponseObjectInput]
}
ResumableUploadInput
ResumableUploadPayload
RetrieveFilePayload
Role
Example
{
"id": 4,
"_id": 4,
"createdAt": {},
"updatedAt": {},
"name": "xyz789",
"acls": ["abc123"],
"app": App,
"system": false,
"tags": ["abc123"],
"etag": 4
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
SubscribeChannelInput
SubscribeChannelPayload
Fields
| Field Name | Description |
|---|---|
channel - Channel | |
error - GenericError | |
clientMutationId - ID |
Example
{
"channel": Channel,
"error": GenericError,
"clientMutationId": "4"
}
SubscriptionPush
Fields
| Field Name | Description |
|---|---|
id - ID! | |
_id - ID! | |
createdAt - Long! | |
updatedAt - Long | |
name - String | |
description - String | |
messages - JSON | |
messagesHydrated - [Message] | |
app - App! | |
appId - ID | |
sent - [ID] | |
sentCount - Long | |
read - [ID] | |
readCount - Long | |
interacted - [ID] | |
interactedCount - Long | |
tags - [String] | |
agendaMeta - JSON | |
fbMessageTag - String | |
fbOTNTags - [String] | |
errors - [SubscriptionPushError] | |
errorStats - [SubscriptionPushErrorStats] | |
includeAudiences - [Audience] | |
excludeAudiences - [Audience] | |
filter - AudienceFilter | |
memberIds - [ID] | |
memberCount - Long | |
members - MemberConnection | |
scheduleAt - Long | |
sentStart - Long | |
sentEnd - Long | |
agendas - [Agenda] | |
priority - Int | |
parentSubscriptionPush - SubscriptionPush | |
parentSubscriptionPushId - ID | |
childSubscriptionPushes - [SubscriptionPush] | |
childSubscriptionPushIds - [ID] | |
etag - ID | |
Example
{
"id": 4,
"_id": 4,
"createdAt": {},
"updatedAt": {},
"name": "abc123",
"description": "xyz789",
"messages": {},
"messagesHydrated": [Message],
"app": App,
"appId": 4,
"sent": [4],
"sentCount": {},
"read": [4],
"readCount": {},
"interacted": ["4"],
"interactedCount": {},
"tags": ["xyz789"],
"agendaMeta": {},
"fbMessageTag": "xyz789",
"fbOTNTags": ["abc123"],
"errors": [SubscriptionPushError],
"errorStats": [SubscriptionPushErrorStats],
"includeAudiences": [Audience],
"excludeAudiences": [Audience],
"filter": AudienceFilter,
"memberIds": ["4"],
"memberCount": {},
"members": MemberConnection,
"scheduleAt": {},
"sentStart": {},
"sentEnd": {},
"agendas": [Agenda],
"priority": 987,
"parentSubscriptionPush": SubscriptionPush,
"parentSubscriptionPushId": "4",
"childSubscriptionPushes": [SubscriptionPush],
"childSubscriptionPushIds": [4],
"etag": 4
}
SubscriptionPushConnection
Fields
| Field Name | Description |
|---|---|
edges - [SubscriptionPushEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [SubscriptionPushEdge],
"pageInfo": PageInfo
}
SubscriptionPushEdge
Fields
| Field Name | Description |
|---|---|
node - SubscriptionPush | |
cursor - ID! |
Example
{
"node": SubscriptionPush,
"cursor": "4"
}
SubscriptionPushError
SubscriptionPushErrorInput
SubscriptionPushErrorStats
TagFilter
Description
An object made up of an operator and an array of tags
Fields
| Input Field | Description |
|---|---|
operator - String | A string of operator. This filter only accepts IN or NIN. IN: Filter the result to members that have matching tags. NIN: Filter the result to members that do not have matching tags. |
tags - [String] | An array of strings for tags. Used together with operator to filter members based on their tags. |
Example
{
"operator": "xyz789",
"tags": ["xyz789"]
}
TeamMember
Example
{
"email": "xyz789",
"inviteToken": "4",
"status": "xyz789",
"roles": [Role],
"acls": ["xyz789"],
"allAcls": ["abc123"],
"user": User,
"grantBy": User,
"grantById": "4",
"grantAt": {},
"expiry": {}
}
Tree
Fields
| Field Name | Description |
|---|---|
id - ID! | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
_id - ID! | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
createdAt - Long! | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
updatedAt - Long | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
name - String! | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
description - String | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
app - App | scope ["api:admin", "tree:getBasicInfo", "appInfo:get", "appSettings:get", "botbuilder:read"] |
appId - ID | scope ["api:admin", "tree:getBasicInfo", "appInfo:get", "appSettings:get", "botbuilder:read"] |
globalNodes - [NodeObject] | scope ["api:admin", "tree:getNodes", "botbuilder:read"] |
globalNodeIds - [ID] | scope ["api:admin", "tree:getNodes", "botbuilder:read"] |
nodes - [NodeObject] | scope ["api:admin", "tree:getNodes", "botbuilder:read"] |
Arguments
| |
nodeIds - [ID] | scope ["api:admin", "tree:getNodes", "botbuilder:read"] |
workspace - [Workspace] | scope ["api:admin", "tree:getDetails", "botbuilder:read"] |
version - Int | scope ["api:admin", "api:admin", "tree:getBasicInfo", "botbuilder:read"] |
versionAlias - String | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
ancestorTree - Tree | scope ["api:admin", "tree:getDetails", "botbuilder:read"] |
siblingTrees - [Tree] | scope ["api:admin", "tree:getDetails", "botbuilder:read"] |
tags - [String] | scope ["api:admin", "tree:getDetails", "botbuilder:read"] |
stash - [NodeObject] | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
etag - ID | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
configMapSchema - JSON | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
configMap - JSON | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
type - String | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
system - Boolean | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
templateTreeId - ID | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
templateTree - Tree | scope ["api:admin", "tree:getTreeSetting", "botbuilder:read"] |
locked - Boolean | scope ["api:admin", "tree:getBasicInfo", "botbuilder:read"] |
Example
{
"id": "4",
"_id": 4,
"createdAt": {},
"updatedAt": {},
"name": "xyz789",
"description": "abc123",
"app": App,
"appId": "4",
"globalNodes": [NodeObject],
"globalNodeIds": [4],
"nodes": [NodeObject],
"nodeIds": ["4"],
"workspace": [Workspace],
"version": 987,
"versionAlias": "xyz789",
"ancestorTree": Tree,
"siblingTrees": [Tree],
"tags": ["abc123"],
"stash": [NodeObject],
"etag": 4,
"configMapSchema": {},
"configMap": {},
"type": "xyz789",
"system": true,
"templateTreeId": 4,
"templateTree": Tree,
"locked": true
}
TreeConnection
Fields
| Field Name | Description |
|---|---|
edges - [TreeEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [TreeEdge],
"pageInfo": PageInfo
}
TreeEdge
Trigger
Example
{
"id": 4,
"_id": 4,
"createdAt": {},
"updatedAt": {},
"name": "xyz789",
"description": "abc123",
"conditions": {},
"rawConditions": {},
"templateInfo": {},
"app": App,
"etag": 4,
"history": [{}],
"tags": ["xyz789"]
}
TriggerConnection
Fields
| Field Name | Description |
|---|---|
edges - [TriggerEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [TriggerEdge],
"pageInfo": PageInfo
}
TriggerEdge
UninstalledIntegration
Example
{
"icon": "abc123",
"integrationName": "xyz789",
"integrationId": 4,
"build": 123,
"version": "xyz789",
"isPlatform": true,
"private": false
}
UnsetKeysInput
UnsubscribeChannelInput
UnsubscribeChannelPayload
Fields
| Field Name | Description |
|---|---|
error - GenericError | |
forceRequest - Boolean | |
errorMessage - String | |
errors - [endpointError] | |
clientMutationId - ID |
Example
{
"error": GenericError,
"forceRequest": true,
"errorMessage": "xyz789",
"errors": [endpointError],
"clientMutationId": 4
}
UpdateActionInput
Example
{
"actionId": 4,
"app": "4",
"etag": 4,
"name": "abc123",
"description": "xyz789",
"functionString": "abc123",
"tags": ["xyz789"],
"history": [{}],
"clientMutationId": "4"
}
UpdateActionPayload
UpdateAgendaInput
Fields
| Input Field | Description |
|---|---|
agendaId - ID! | |
app - ID | |
etag - ID | |
member - ID | |
tree - ID | |
nodeCompositeId - ID | |
nextRunAt - Long | |
completed - Boolean | |
pattern - String | |
runUntil - Long | |
type - String | |
meta - JSON | |
priority - Int | |
subscriptionPush - AgendaSubscriptionPushConfigInput | |
tag - String | |
clientMutationId - ID |
Example
{
"agendaId": 4,
"app": 4,
"etag": "4",
"member": 4,
"tree": 4,
"nodeCompositeId": "4",
"nextRunAt": {},
"completed": true,
"pattern": "xyz789",
"runUntil": {},
"type": "xyz789",
"meta": {},
"priority": 123,
"subscriptionPush": AgendaSubscriptionPushConfigInput,
"tag": "abc123",
"clientMutationId": 4
}
UpdateAgendaPayload
UpdateAppIntegrationInput
Description
An input for UpdateAppIntegration.
Example
{
"appId": 4,
"integrationId": "4",
"integration": {},
"clientMutationId": 4
}
UpdateAppIntegrationMetaInput
UpdateAppIntegrationMetaPayload
Fields
| Field Name | Description |
|---|---|
appIntegration - AppIntegration | |
clientMutationId - ID |
Example
{"appIntegration": AppIntegration, "clientMutationId": 4}
UpdateAppIntegrationPayload
UpdateAudienceInput
Example
{
"audienceId": 4,
"app": "4",
"etag": 4,
"name": "abc123",
"description": "abc123",
"filter": AudienceFilterInput,
"channel": "4",
"tags": ["abc123"],
"clientMutationId": 4
}
UpdateAudiencePayload
UpdateChannelEnvironmentHooksInput
Example
{
"channelId": "4",
"environmentId": "4",
"preCoreEntryAsync": [4],
"preCoreEntrySync": [4],
"postCoreEntry": ["4"],
"option": "xyz789",
"clientMutationId": 4,
"app": "4"
}
UpdateChannelEnvironmentInput
Fields
| Input Field | Description |
|---|---|
channelId - ID! | Target channel Id |
environmentId - ID | Target environment id (default: default) |
name - String | Environment name |
webhooks - ChannelEnvironmentWebhooks | Environment webhooks (old format) |
webhooksV2 - [ChannelWebhookV2Input] | Environment webhooks (new format) |
hooks - ChannelHooksInput | Environment hooks |
on - Boolean | Environment global on/off toggle |
availability - JSON | Tree Availability setting |
treeIds - [ID] | Default Tree ids |
group - ID | Priority Group ID |
globalNodeIds - [ID] | Default global modes Ids |
offTreeIds - [ID] | Off Tree ids |
offGlobalNodeIds - [ID] | Off global modes Ids |
livechatTreeIds - [ID] | Live chat Tree ids |
livechatGlobalNodeIds - [ID] | Live chat global modes Ids |
coreVersion - String | Environment core version |
meta - JSON | |
option - String | Option on tree and node ids, only accept $addToSet or $set |
clientMutationId - ID | |
app - ID |
Example
{
"channelId": 4,
"environmentId": 4,
"name": "xyz789",
"webhooks": ChannelEnvironmentWebhooks,
"webhooksV2": [ChannelWebhookV2Input],
"hooks": ChannelHooksInput,
"on": true,
"availability": {},
"treeIds": ["4"],
"group": 4,
"globalNodeIds": ["4"],
"offTreeIds": [4],
"offGlobalNodeIds": ["4"],
"livechatTreeIds": ["4"],
"livechatGlobalNodeIds": [4],
"coreVersion": "abc123",
"meta": {},
"option": "abc123",
"clientMutationId": "4",
"app": 4
}
UpdateChannelEnvironmentLivechatTreeGlobalNodeInput
Example
{
"channelId": 4,
"environmentId": 4,
"livechatTrees": [4],
"livechatGlobalNodes": ["4"],
"option": "abc123",
"clientMutationId": 4,
"app": "4"
}
UpdateChannelEnvironmentOffTreeGlobalNodeInput
Example
{
"channelId": "4",
"environmentId": "4",
"offTrees": ["4"],
"offGlobalNodes": ["4"],
"option": "abc123",
"clientMutationId": "4",
"app": 4
}
UpdateChannelEnvironmentTreeGlobalNodeInput
Example
{
"channelId": "4",
"environmentId": 4,
"trees": [4],
"globalNodes": ["4"],
"option": "xyz789",
"clientMutationId": 4,
"app": 4
}
UpdateChannelEnvironmentWebhooksInput
Fields
| Input Field | Description |
|---|---|
channelId - ID! | Target channel Id |
environmentId - ID | Target environment id (default: default) |
normalizedInbound - [ChannelEnvironmentWebhookDetail] | Environment inbound webhooks (old format) |
normalizedOutbound - [ChannelEnvironmentWebhookDetail] | Environment outbound webhooks (old format) |
webhooksV2 - [ChannelWebhookV2ActionInput] | Environment webhooks (new format) |
option - String | Only accept $addToSet or $pull, only used for normalizedInbound normalizedOutbound inputs |
clientMutationId - ID | |
app - ID |
Example
{
"channelId": 4,
"environmentId": 4,
"normalizedInbound": [ChannelEnvironmentWebhookDetail],
"normalizedOutbound": [ChannelEnvironmentWebhookDetail],
"webhooksV2": [ChannelWebhookV2ActionInput],
"option": "xyz789",
"clientMutationId": 4,
"app": "4"
}
UpdateChannelIncomingWebhookInput
Fields
| Input Field | Description |
|---|---|
channelId - ID! | |
etag - ID | |
incomingWebhooks - [ChannelIncomingWebhookActionInput] | |
clientMutationId - ID |
Example
{
"channelId": "4",
"etag": "4",
"incomingWebhooks": [ChannelIncomingWebhookActionInput],
"clientMutationId": 4
}
UpdateChannelIncomingWebhookPayload
UpdateChannelInput
Example
{
"channelId": 4,
"app": "4",
"etag": "4",
"name": "xyz789",
"description": "xyz789",
"meta": {},
"tags": ["xyz789"],
"clientMutationId": "4",
"on": false
}
UpdateChannelPayload
Fields
| Field Name | Description |
|---|---|
channel - Channel | |
error - GenericError | |
clientMutationId - ID |
Example
{
"channel": Channel,
"error": GenericError,
"clientMutationId": "4"
}
UpdateChannelPriorityGroupInput
Fields
| Input Field | Description |
|---|---|
channelId - ID! | |
priorityGroupId - String | |
treeIds - [ID] | |
globalNodeIds - [ID] | |
groupTreeIds - [ID] | |
groupGlobalNodeIds - [ID] | |
offTreeIds - [ID] | |
offGlobalNodeIds - [ID] | |
livechatTreeIds - [ID] | |
livechatGlobalNodeIds - [ID] | |
coreVersion - String | |
meta - JSON | |
override - Boolean | |
overrideOn - Boolean | |
option - String | |
app - ID |
Example
{
"channelId": "4",
"priorityGroupId": "abc123",
"treeIds": [4],
"globalNodeIds": [4],
"groupTreeIds": ["4"],
"groupGlobalNodeIds": [4],
"offTreeIds": ["4"],
"offGlobalNodeIds": [4],
"livechatTreeIds": ["4"],
"livechatGlobalNodeIds": [4],
"coreVersion": "abc123",
"meta": {},
"override": true,
"overrideOn": false,
"option": "xyz789",
"app": 4
}
UpdateConditionInput
Example
{
"conditionId": 4,
"app": "4",
"etag": "4",
"name": "xyz789",
"description": "xyz789",
"functionString": "abc123",
"autogen": false,
"tags": ["abc123"],
"history": [{}],
"clientMutationId": 4
}
UpdateConditionPayload
UpdateDataSourceDocInput
Description
Input type for updating datasource doc.
Example
{
"app": 4,
"etag": "4",
"collectionName": "xyz789",
"data": {},
"clientMutationId": 4
}
UpdateDataSourceDocPayload
UpdateDataSourceDocsInput
Description
Input type for updating datasource docs.
Fields
| Input Field | Description |
|---|---|
collectionName - ID! | Datasource id in Stella. |
filter - JSON | MongoDB filter apply to filter doc from datasource. |
patch - JSON | MongoDB patch option to update docs in datasource |
options - JSON | MongoDB options in updating docs in datasource |
multi - Boolean | Update multi documents or not |
clientMutationId - ID |
Example
{
"collectionName": "4",
"filter": {},
"patch": {},
"options": {},
"multi": false,
"clientMutationId": "4"
}
UpdateDataSourceDocsPayload
UpdateDataSourceInput
Description
Input type for updating datasource.
Example
{
"app": "4",
"name": "abc123",
"description": "abc123",
"collectionName": 4,
"clientMutationId": 4
}
UpdateDataSourcePayload
Description
Return type for updating datasource.
Fields
| Field Name | Description |
|---|---|
dataSource - DataSource | Datasource that updated. |
clientMutationId - ID |
Example
{
"dataSource": DataSource,
"clientMutationId": "4"
}
UpdateLocaleGroupInput
UpdateLocaleGroupPayload
Fields
| Field Name | Description |
|---|---|
localeGroup - LocaleGroup | |
clientMutationId - ID |
Example
{"localeGroup": LocaleGroup, "clientMutationId": 4}
UpdateMemberForBotPayload
UpdateMemberInput
Fields
| Input Field | Description |
|---|---|
memberId - ID! | |
app - ID | |
etag - ID | |
profile - JSON | |
profileWithSchema - MemberProfileInput | |
inboxProfile - InboxMemberProfileInput | |
tags - [String] | |
meta - JSON | |
botMeta - BotMetaInput | |
unsetKeys - UnsetKeysInput | |
admin - ID | |
group - ID | |
firstName - String | |
lastName - String | |
profilePic - String | |
gender - String | |
locale - String | |
customLocale - String | |
email - String | |
profilePicString - String | |
clientMutationId - ID |
Example
{
"memberId": 4,
"app": 4,
"etag": 4,
"profile": {},
"profileWithSchema": MemberProfileInput,
"inboxProfile": InboxMemberProfileInput,
"tags": ["abc123"],
"meta": {},
"botMeta": BotMetaInput,
"unsetKeys": UnsetKeysInput,
"admin": 4,
"group": "4",
"firstName": "xyz789",
"lastName": "xyz789",
"profilePic": "abc123",
"gender": "xyz789",
"locale": "xyz789",
"customLocale": "abc123",
"email": "abc123",
"profilePicString": "abc123",
"clientMutationId": "4"
}
UpdateMemberPayload
UpdateMembersInput
UpdateMembersPayload
UpdateNodeInput
Fields
| Input Field | Description |
|---|---|
nodeId - ID! | |
app - ID | |
etag - ID | |
name - String | |
description - String | |
trigger - ID | |
preActions - [ID] | |
responses - [ID] | |
postActions - [ID] | |
actions - [ID] | |
priority - Int | |
colour - String | |
path - String | |
global - Boolean | |
redirect - RedirectInput | |
analytics - AnalyticsInput | |
memberTagging - MemberTaggingInput | |
type - NodeObjectType | |
dialogflow - DialogflowSettingsInput | |
luis - LuisSettingsInput | |
tags - [String] | |
clientMutationId - ID | |
saveCompositeId - Boolean |
Example
{
"nodeId": "4",
"app": 4,
"etag": "4",
"name": "xyz789",
"description": "abc123",
"trigger": 4,
"preActions": [4],
"responses": [4],
"postActions": [4],
"actions": ["4"],
"priority": 123,
"colour": "xyz789",
"path": "abc123",
"global": false,
"redirect": RedirectInput,
"analytics": AnalyticsInput,
"memberTagging": MemberTaggingInput,
"type": "GENERAL",
"dialogflow": DialogflowSettingsInput,
"luis": LuisSettingsInput,
"tags": ["xyz789"],
"clientMutationId": "4",
"saveCompositeId": true
}
UpdateNodePayload
Fields
| Field Name | Description |
|---|---|
node - NodeObject | |
clientMutationId - ID |
Example
{
"node": NodeObject,
"clientMutationId": "4"
}
UpdateNoteInput
UpdateNotePayload
Fields
| Field Name | Description |
|---|---|
note - Note | |
error - GenericError | |
clientMutationId - ID |
Example
{
"note": Note,
"error": GenericError,
"clientMutationId": 4
}
UpdatePairsInAppInput
Description
An input for UpdatePairsInApp
Fields
| Input Field | Description |
|---|---|
pairs - [PairInput]! | Pair array for inlet and outlet |
clientMutationId - ID |
Example
{"pairs": [PairInput], "clientMutationId": 4}
UpdatePairsInAppPayload
UpdatePriorityGroupInput
Example
{
"priorityGroupId": 4,
"app": "4",
"etag": "4",
"name": "xyz789",
"description": "abc123",
"channel": 4,
"members": ["4"],
"tags": ["abc123"],
"clientMutationId": 4
}
UpdatePriorityGroupPayload
Fields
| Field Name | Description |
|---|---|
priorityGroup - PriorityGroup | |
clientMutationId - ID |
Example
{"priorityGroup": PriorityGroup, "clientMutationId": 4}
UpdateResponseInput
Example
{
"responseId": "4",
"app": "4",
"etag": 4,
"name": "xyz789",
"description": "xyz789",
"localeGroups": [ResponseLocaleGroupInput],
"history": [{}],
"tags": ["abc123"],
"clientMutationId": 4
}
UpdateResponsePayload
UpdateSubscriptionPushInput
Fields
| Input Field | Description |
|---|---|
subscriptionPushId - ID! | |
app - ID | |
etag - ID | |
name - String | |
description - String | |
messages - JSON | Example: "messages" : [{ "platforms" : [{ "integrationId" : "woztell-essential-pack", "build" : 1, "localeGroups" : [{ "localeGroup" : "default", "variations" : [{ "name" : "Standard", "responses" : [{ "type" : "TEXT", "text" : "Hello World", "id" : "EQeUe7ZA", "transform" : "" }] }] }] }] }] |
sent - [ID] | |
read - [ID] | |
interacted - [ID] | |
tags - [String] | |
agendaMeta - JSON | |
errors - [SubscriptionPushErrorInput] | |
includeAudiences - [ID] | |
excludeAudiences - [ID] | |
fbMessageTag - String | |
fbOTNTags - [String] | |
filter - AudienceFilterInput | |
members - [ID] | |
sentStart - Long | |
sentEnd - Long | |
scheduleAt - Long | |
agendas - [ID] | |
childSubscriptionPushes - [ID] | |
priority - Int | |
clientMutationId - ID |
Example
{
"subscriptionPushId": 4,
"app": "4",
"etag": 4,
"name": "xyz789",
"description": "xyz789",
"messages": {},
"sent": [4],
"read": [4],
"interacted": ["4"],
"tags": ["abc123"],
"agendaMeta": {},
"errors": [SubscriptionPushErrorInput],
"includeAudiences": ["4"],
"excludeAudiences": [4],
"fbMessageTag": "abc123",
"fbOTNTags": ["xyz789"],
"filter": AudienceFilterInput,
"members": [4],
"sentStart": {},
"sentEnd": {},
"scheduleAt": {},
"agendas": ["4"],
"childSubscriptionPushes": ["4"],
"priority": 123,
"clientMutationId": "4"
}
UpdateSubscriptionPushPayload
Fields
| Field Name | Description |
|---|---|
subscriptionPush - SubscriptionPush | |
clientMutationId - ID |
Example
{
"subscriptionPush": SubscriptionPush,
"clientMutationId": 4
}
UpdateTreeInput
Fields
| Input Field | Description |
|---|---|
treeId - ID! | |
app - ID | |
etag - ID | |
name - String | |
description - String | |
versionAlias - String | |
globalNodes - [ID] | |
nodes - [ID] | |
workspace - [WorkspaceInput] | |
stash - [ID] | |
tags - [String] | |
configMapSchema - JSON | |
configMap - JSON | |
type - String | |
templateTreeId - ID | |
clientMutationId - ID | |
system - Boolean |
Example
{
"treeId": 4,
"app": "4",
"etag": "4",
"name": "xyz789",
"description": "xyz789",
"versionAlias": "xyz789",
"globalNodes": [4],
"nodes": [4],
"workspace": [WorkspaceInput],
"stash": [4],
"tags": ["abc123"],
"configMapSchema": {},
"configMap": {},
"type": "xyz789",
"templateTreeId": "4",
"clientMutationId": 4,
"system": false
}
UpdateTreePayload
UpdateTriggerInput
Example
{
"triggerId": "4",
"app": "4",
"etag": 4,
"name": "abc123",
"description": "abc123",
"conditions": {},
"templateInfo": {},
"tags": ["abc123"],
"history": [{}],
"clientMutationId": 4
}
UpdateTriggerPayload
UpdateWebchatMemberForBotInput
Example
{
"memberId": "4",
"channel": 4,
"webchatToken": "4",
"app": "4",
"tags": ["abc123"],
"group": "4",
"meta": {},
"botMeta": {},
"customLocale": "abc123",
"locale": "abc123",
"admin": 4,
"clientMutationId": 4
}
UpsertDataSourceDocsInput
UpsertDataSourceDocsPayload
UpsertMemberByExternalIdInput
Fields
| Input Field | Description |
|---|---|
externalId - ID! | |
newExternalId - ID | |
app - ID | |
channel - ID! | |
webchatToken - ID! | |
platform - String! | |
profile - JSON | |
tags - [String] | |
meta - JSON | |
botMeta - BotMetaInput | |
botId - ID | |
admin - ID | |
group - ID | |
fbId - ID | |
name - String | |
firstName - String | |
lastName - String | |
profilePic - String | |
email - String | |
gender - String | |
locale - String | |
customLocale - String | |
profilePicString - String | |
fbUserRef - Boolean | |
fbOTNToken - JSON | |
conversationId - String | |
trackActiveMember - Boolean | |
trackNewMember - Boolean | |
clientMutationId - ID |
Example
{
"externalId": 4,
"newExternalId": 4,
"app": "4",
"channel": 4,
"webchatToken": 4,
"platform": "abc123",
"profile": {},
"tags": ["xyz789"],
"meta": {},
"botMeta": BotMetaInput,
"botId": 4,
"admin": 4,
"group": 4,
"fbId": "4",
"name": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"profilePic": "xyz789",
"email": "abc123",
"gender": "abc123",
"locale": "abc123",
"customLocale": "xyz789",
"profilePicString": "abc123",
"fbUserRef": true,
"fbOTNToken": {},
"conversationId": "abc123",
"trackActiveMember": false,
"trackNewMember": true,
"clientMutationId": "4"
}
UpsertMemberByExternalIdPayload
User
Fields
| Field Name | Description |
|---|---|
id - ID! | |
_id - ID! | |
createdAt - Long! | |
updatedAt - Long | |
apps - [UserAppConfig] | scope ["api:admin", "user:getApps"] |
partners - [UserPartnerConfig] | scope ["api:admin", "user:getPartners"] |
firstName - String | scope ["api:admin", "user:getProfile", "teamMember:list"] |
lastName - String | scope ["api:admin", "user:getProfile", "teamMember:list"] |
fullName - String | scope ["api:admin", "user:getProfile", "teamMember:list"] |
profilePic - String | scope ["api:admin", "user:getProfile", "teamMember:list"] |
ownRoles - [Role] | scope ["api:admin", "user:getRoles"] |
acls - [String] | scope ["api:admin", "user:getRoles"] |
email - EmailCred | scope ["api:admin", "user:getProfile", "teamMember:list"] |
meta - JSON | |
tags - [String] | |
platformCred - PlatformCred | |
sessionMeta - JSON | |
preferences - UserPreferences | |
etag - ID | |
stripeProducts - JSON |
Example
{
"id": 4,
"_id": 4,
"createdAt": {},
"updatedAt": {},
"apps": [UserAppConfig],
"partners": [UserPartnerConfig],
"firstName": "abc123",
"lastName": "abc123",
"fullName": "xyz789",
"profilePic": "abc123",
"ownRoles": [Role],
"acls": ["xyz789"],
"email": EmailCred,
"meta": {},
"tags": ["xyz789"],
"platformCred": PlatformCred,
"sessionMeta": {},
"preferences": UserPreferences,
"etag": 4,
"stripeProducts": {}
}
UserAppConfig
UserPartnerConfig
UserPreferences
WABAIntegration
WebhookEventType
Values
| Enum Value | Description |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Example
"INBOUND"
WhatsAppFileUrl
WhatsAppMessageTemplate
WhatsAppMessageTemplateConnection
Fields
| Field Name | Description |
|---|---|
edges - [WhatsAppMessageTemplateEdge] | |
pageInfo - PageInfo |
Example
{
"edges": [WhatsAppMessageTemplateEdge],
"pageInfo": PageInfo
}
WhatsAppMessageTemplateEdge
Fields
| Field Name | Description |
|---|---|
node - WhatsAppMessageTemplate | |
cursor - ID |
Example
{"node": WhatsAppMessageTemplate, "cursor": 4}
Workspace
Fields
| Field Name | Description |
|---|---|
node - NodeObject | |
coordinates - Coordinates | |
meta - JSON |
Example
{
"node": NodeObject,
"coordinates": Coordinates,
"meta": {}
}
WorkspaceInput
Fields
| Input Field | Description |
|---|---|
node - ID | |
coordinates - CoordinatesInput |
Example
{"node": 4, "coordinates": CoordinatesInput}
endpointError
toggleLiveChatInput
Description
An input for ToggleLiveChat
Fields
| Input Field | Description |
|---|---|
memberId - ID | The identifier for the user. Used to filter to the correct user |
externalId - ID | Dangerous!!! May have same externalId under same app The external identifier for the user. Used to filter if memberId is missing |
appId - ID | The identifier for the app the user is using. Used to filter the appID |
liveChat - Boolean! | The boolean input for the toggle action. LiveChat will be set to this boolean |
clientMutationId - ID | Client mutation id for relay |
Example
{
"memberId": 4,
"externalId": "4",
"appId": "4",
"liveChat": false,
"clientMutationId": "4"
}
toggleLiveChatPayload
Description
The return payload for ToggleLiveChat. Used to toggle the Live Chat setting for the user.
Fields
| Field Name | Description |
|---|---|
ok - Int | Used signify whether the action has succeed. Returning 1 for success, 0 for failure. |
err_code - Int | The error code. Returns the code of the error. |
err - String | The error message. Returns a string explaining what error has occurred. |
memberId - ID | |
member - Member | |
clientMutationId - ID | Client mutation id for relay |
Example
{
"ok": 987,
"err_code": 987,
"err": "xyz789",
"memberId": "4",
"member": Member,
"clientMutationId": "4"
}