DocumentazioneEngagement Platform API
Sign inGet started
Guides
API

Automation Rules

GET
/workspaces/{workspaceId}/inbox/automation/rules
List inbox automation rules
Parametri di query
trigger
string
Rule trigger
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
enabled
boolean
Rule enabled state
Payload della risposta
results
array of object
obbligatorio
Mostra attributi secondari
results.id
string
obbligatorio
results.name
string
obbligatorio
results.description
string
results.categoryId
string
obbligatorio
results.trigger
string
obbligatorio
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
results.triggerArguments
object
results.orderPosition
number
results.enabled
boolean
obbligatorio
results.conditions
object
obbligatorio
Mostra attributi secondari
results.conditions.all
array of object
Mostra attributi secondari
results.conditions.all.name
string
obbligatorio
results.conditions.all.value
object
results.conditions.any
array of object
Mostra attributi secondari
results.conditions.any.name
string
obbligatorio
results.conditions.any.value
object
results.actions
array of object
Mostra attributi secondari
results.actions.name
string
obbligatorio
results.actions.value
object
results.createdAt
string
obbligatorio
results.updatedAt
string
obbligatorio
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/rules' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/inbox/automation/rules/reorder
Reorder automation rule
Payload della richiesta
trigger
string
obbligatorio
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
rules
array of object
obbligatorio
Mostra parametri secondari
rules.ruleId
string
obbligatorio
rules.newCategoryId
string
rules.newOrderPosition
number
obbligatorio
Esempio di codice
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/rules/reorder' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}
Get automation rule
Payload della risposta
id
string
obbligatorio
name
string
obbligatorio
description
string
categoryId
string
obbligatorio
trigger
string
obbligatorio
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
triggerArguments
object
orderPosition
number
enabled
boolean
obbligatorio
conditions
object
obbligatorio
Mostra attributi secondari
conditions.all
array of object
Mostra attributi secondari
conditions.all.name
string
obbligatorio
conditions.all.value
object
conditions.any
array of object
Mostra attributi secondari
conditions.any.name
string
obbligatorio
conditions.any.value
object
actions
array of object
Mostra attributi secondari
actions.name
string
obbligatorio
actions.value
object
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}
Update automation rule
Payload della richiesta
name
string
description
string
enabled
boolean
trigger
string
triggerArguments
object
categoryId
string
conditions
object
Mostra parametri secondari
conditions.all
array of object
Mostra parametri secondari
conditions.all.name
string
obbligatorio
conditions.all.value
object
conditions.any
array of object
Mostra parametri secondari
conditions.any.name
string
obbligatorio
conditions.any.value
object
actions
array of object
Mostra parametri secondari
actions.name
string
obbligatorio
actions.value
object
Payload della risposta
id
string
obbligatorio
name
string
obbligatorio
description
string
categoryId
string
obbligatorio
trigger
string
obbligatorio
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
triggerArguments
object
orderPosition
number
enabled
boolean
obbligatorio
conditions
object
obbligatorio
Mostra attributi secondari
conditions.all
array of object
Mostra attributi secondari
conditions.all.name
string
obbligatorio
conditions.all.value
object
conditions.any
array of object
Mostra attributi secondari
conditions.any.name
string
obbligatorio
conditions.any.value
object
actions
array of object
Mostra attributi secondari
actions.name
string
obbligatorio
actions.value
object
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
Esempio di codice
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}
Delete automation rule
Esempio di codice
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/inbox/automation/categories
List inbox automation categories
Payload della risposta
results
array of object
obbligatorio
Mostra attributi secondari
results.id
string
obbligatorio
results.name
string
obbligatorio
results.orderPosition
number
results.createdAt
string
obbligatorio
results.updatedAt
string
obbligatorio
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/categories' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/inbox/automation/categories
Create automation category
Payload della richiesta
name
string
obbligatorio
Payload della risposta
id
string
obbligatorio
name
string
obbligatorio
orderPosition
number
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
Esempio di codice
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/categories' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/inbox/automation/categories/reorder
Reorder automation categories
Payload della richiesta
categories
array of object
obbligatorio
Mostra parametri secondari
categories.categoryId
string
obbligatorio
categories.newOrderPosition
number
obbligatorio
Esempio di codice
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/categories/reorder' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}
Update automation category
Payload della richiesta
name
string
obbligatorio
Payload della risposta
id
string
obbligatorio
name
string
obbligatorio
orderPosition
number
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
Esempio di codice
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}
Delete automation category
Esempio di codice
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/inbox/automation/new-item-reply
Get current new-item reply configuration.
Payload della risposta
projectId
string
obbligatorio
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/new-item-reply' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PUT
/workspaces/{workspaceId}/inbox/automation/new-item-reply
Update or create new-item reply configuration.
Payload della richiesta
projectId
string
obbligatorio
Esempio di codice
curl -X PUT 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/new-item-reply' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'