DokumentasiEngagement Platform API
Sign inGet started
Guides
API

Automation Rules

GET
/workspaces/{workspaceId}/inbox/automation/rules
List inbox automation rules
Parameter 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 respons
results
array of object
wajib
Tampilkan atribut turunan
results.id
string
wajib
results.name
string
wajib
results.description
string
results.categoryId
string
wajib
results.trigger
string
wajib
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
results.triggerArguments
object
results.orderPosition
number
results.enabled
boolean
wajib
results.conditions
object
wajib
Tampilkan atribut turunan
results.conditions.all
array of object
Tampilkan atribut turunan
results.conditions.all.name
string
wajib
results.conditions.all.value
object
results.conditions.any
array of object
Tampilkan atribut turunan
results.conditions.any.name
string
wajib
results.conditions.any.value
object
results.actions
array of object
Tampilkan atribut turunan
results.actions.name
string
wajib
results.actions.value
object
results.createdAt
string
wajib
results.updatedAt
string
wajib
Contoh kode
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 permintaan
trigger
string
wajib
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
rules
array of object
wajib
Tampilkan parameter turunan
rules.ruleId
string
wajib
rules.newCategoryId
string
rules.newOrderPosition
number
wajib
Contoh kode
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 respons
id
string
wajib
name
string
wajib
description
string
categoryId
string
wajib
trigger
string
wajib
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
triggerArguments
object
orderPosition
number
enabled
boolean
wajib
conditions
object
wajib
Tampilkan atribut turunan
conditions.all
array of object
Tampilkan atribut turunan
conditions.all.name
string
wajib
conditions.all.value
object
conditions.any
array of object
Tampilkan atribut turunan
conditions.any.name
string
wajib
conditions.any.value
object
actions
array of object
Tampilkan atribut turunan
actions.name
string
wajib
actions.value
object
createdAt
string
wajib
updatedAt
string
wajib
Contoh kode
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 permintaan
name
string
description
string
enabled
boolean
trigger
string
triggerArguments
object
categoryId
string
conditions
object
Tampilkan parameter turunan
conditions.all
array of object
Tampilkan parameter turunan
conditions.all.name
string
wajib
conditions.all.value
object
conditions.any
array of object
Tampilkan parameter turunan
conditions.any.name
string
wajib
conditions.any.value
object
actions
array of object
Tampilkan parameter turunan
actions.name
string
wajib
actions.value
object
Payload respons
id
string
wajib
name
string
wajib
description
string
categoryId
string
wajib
trigger
string
wajib
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
triggerArguments
object
orderPosition
number
enabled
boolean
wajib
conditions
object
wajib
Tampilkan atribut turunan
conditions.all
array of object
Tampilkan atribut turunan
conditions.all.name
string
wajib
conditions.all.value
object
conditions.any
array of object
Tampilkan atribut turunan
conditions.any.name
string
wajib
conditions.any.value
object
actions
array of object
Tampilkan atribut turunan
actions.name
string
wajib
actions.value
object
createdAt
string
wajib
updatedAt
string
wajib
Contoh kode
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
Contoh kode
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 respons
results
array of object
wajib
Tampilkan atribut turunan
results.id
string
wajib
results.name
string
wajib
results.orderPosition
number
results.createdAt
string
wajib
results.updatedAt
string
wajib
Contoh kode
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 permintaan
name
string
wajib
Payload respons
id
string
wajib
name
string
wajib
orderPosition
number
createdAt
string
wajib
updatedAt
string
wajib
Contoh kode
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 permintaan
categories
array of object
wajib
Tampilkan parameter turunan
categories.categoryId
string
wajib
categories.newOrderPosition
number
wajib
Contoh kode
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 permintaan
name
string
wajib
Payload respons
id
string
wajib
name
string
wajib
orderPosition
number
createdAt
string
wajib
updatedAt
string
wajib
Contoh kode
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
Contoh kode
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 respons
projectId
string
wajib
Contoh kode
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 permintaan
projectId
string
wajib
Contoh kode
curl -X PUT 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/new-item-reply' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'