Integrations
Update integration
API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate subscriber credentials
- DELDelete subscriber credentials by providerId
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETGet in-app notification feed for a particular subscriber
- GETGet the unseen in-app notifications count for subscribers feed
- POSTMark a subscriber feed message as seen
- POSTMarks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Organizations
Integrations
Update integration
PUT
/
v1
/
integrations
/
{integrationId}
Authorization
string
*
Authorization
Required
string
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
integrationId
string
*
integrationId
Required
string
object
*
name
string
name
string
identifier
string
identifier
string
_environmentId
string
_environmentId
string
active
boolean
active
boolean
If the integration is active the validation on the credentials field will run
credentials
object
credentials
object
apiKey
string
apiKey
string
user
string
user
string
secretKey
string
secretKey
string
domain
string
domain
string
password
string
password
string
host
string
host
string
port
string
port
string
secure
boolean
secure
boolean
region
string
region
string
accountSid
string
accountSid
string
messageProfileId
string
messageProfileId
string
token
string
token
string
from
string
from
string
senderName
string
senderName
string
projectName
string
projectName
string
applicationId
string
applicationId
string
clientId
string
clientId
string
requireTls
boolean
requireTls
boolean
ignoreTls
boolean
ignoreTls
boolean
tlsOptions
object
tlsOptions
object
baseUrl
string
baseUrl
string
webhookUrl
string
webhookUrl
string
redirectUrl
string
redirectUrl
string
hmac
boolean
hmac
boolean
serviceAccount
string
serviceAccount
string
ipPoolName
string
ipPoolName
string
apiKeyRequestHeader
string
apiKeyRequestHeader
string
secretKeyRequestHeader
string
secretKeyRequestHeader
string
idPath
string
idPath
string
datePath
string
datePath
string
apiToken
string
apiToken
string
authenticateByToken
boolean
authenticateByToken
boolean
authenticationTokenKey
string
authenticationTokenKey
string
instanceId
string
instanceId
string
alertUid
string
alertUid
string
title
string
title
string
imageUrl
string
imageUrl
string
state
string
state
string
externalLink
string
externalLink
string
channelId
string
channelId
string
phoneNumberIdentification
string
phoneNumberIdentification
string
accessKey
string
accessKey
string
check
boolean
check
boolean
conditions
array
conditions
array
Enter your API key in the Authorization field like the example shown below:
E.g ApiKey 18d2e625f05d80e
Authorizations
Authorization
string
headerrequiredAPI key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
integrationId
string
requiredBody
application/json
name
string
identifier
string
_environmentId
string
active
boolean
If the integration is active the validation on the credentials field will run
credentials
object
check
boolean
conditions
object[]
Response
200 - application/json
data
object
Was this page helpful?