DocumentaciónEngagement Platform API
Sign inGet started
Guides
API

Automation Rules

GET
/workspaces/{workspaceId}/inbox/automation/rules
List inbox automation rules
Parámetros de consulta
trigger
string
Rule trigger
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
enabled
boolean
Rule enabled state
Cuerpo de la respuesta
results
array of object
obligatorio
Mostrar atributos secundarios
results.id
string
obligatorio
results.name
string
obligatorio
results.description
string
results.categoryId
string
obligatorio
results.trigger
string
obligatorio
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
results.triggerArguments
object
results.orderPosition
number
results.enabled
boolean
obligatorio
results.conditions
object
obligatorio
Mostrar atributos secundarios
results.conditions.all
array of object
Mostrar atributos secundarios
results.conditions.all.name
string
obligatorio
results.conditions.all.value
object
results.conditions.any
array of object
Mostrar atributos secundarios
results.conditions.any.name
string
obligatorio
results.conditions.any.value
object
results.actions
array of object
Mostrar atributos secundarios
results.actions.name
string
obligatorio
results.actions.value
object
results.createdAt
string
obligatorio
results.updatedAt
string
obligatorio
Ejemplo de código
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
Cuerpo de la solicitud
trigger
string
obligatorio
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
rules
array of object
obligatorio
Mostrar parámetros secundarios
rules.ruleId
string
obligatorio
rules.newCategoryId
string
rules.newOrderPosition
number
obligatorio
Ejemplo de código
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
Cuerpo de la respuesta
id
string
obligatorio
name
string
obligatorio
description
string
categoryId
string
obligatorio
trigger
string
obligatorio
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
triggerArguments
object
orderPosition
number
enabled
boolean
obligatorio
conditions
object
obligatorio
Mostrar atributos secundarios
conditions.all
array of object
Mostrar atributos secundarios
conditions.all.name
string
obligatorio
conditions.all.value
object
conditions.any
array of object
Mostrar atributos secundarios
conditions.any.name
string
obligatorio
conditions.any.value
object
actions
array of object
Mostrar atributos secundarios
actions.name
string
obligatorio
actions.value
object
createdAt
string
obligatorio
updatedAt
string
obligatorio
Ejemplo de código
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
Cuerpo de la solicitud
name
string
description
string
enabled
boolean
trigger
string
triggerArguments
object
categoryId
string
conditions
object
Mostrar parámetros secundarios
conditions.all
array of object
Mostrar parámetros secundarios
conditions.all.name
string
obligatorio
conditions.all.value
object
conditions.any
array of object
Mostrar parámetros secundarios
conditions.any.name
string
obligatorio
conditions.any.value
object
actions
array of object
Mostrar parámetros secundarios
actions.name
string
obligatorio
actions.value
object
Cuerpo de la respuesta
id
string
obligatorio
name
string
obligatorio
description
string
categoryId
string
obligatorio
trigger
string
obligatorio
Possible values: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
triggerArguments
object
orderPosition
number
enabled
boolean
obligatorio
conditions
object
obligatorio
Mostrar atributos secundarios
conditions.all
array of object
Mostrar atributos secundarios
conditions.all.name
string
obligatorio
conditions.all.value
object
conditions.any
array of object
Mostrar atributos secundarios
conditions.any.name
string
obligatorio
conditions.any.value
object
actions
array of object
Mostrar atributos secundarios
actions.name
string
obligatorio
actions.value
object
createdAt
string
obligatorio
updatedAt
string
obligatorio
Ejemplo de código
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
Ejemplo de código
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
Cuerpo de la respuesta
results
array of object
obligatorio
Mostrar atributos secundarios
results.id
string
obligatorio
results.name
string
obligatorio
results.orderPosition
number
results.createdAt
string
obligatorio
results.updatedAt
string
obligatorio
Ejemplo de código
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
Cuerpo de la solicitud
name
string
obligatorio
Cuerpo de la respuesta
id
string
obligatorio
name
string
obligatorio
orderPosition
number
createdAt
string
obligatorio
updatedAt
string
obligatorio
Ejemplo de código
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
Cuerpo de la solicitud
categories
array of object
obligatorio
Mostrar parámetros secundarios
categories.categoryId
string
obligatorio
categories.newOrderPosition
number
obligatorio
Ejemplo de código
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
Cuerpo de la solicitud
name
string
obligatorio
Cuerpo de la respuesta
id
string
obligatorio
name
string
obligatorio
orderPosition
number
createdAt
string
obligatorio
updatedAt
string
obligatorio
Ejemplo de código
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
Ejemplo de código
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.
Cuerpo de la respuesta
projectId
string
obligatorio
Ejemplo de código
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.
Cuerpo de la solicitud
projectId
string
obligatorio
Ejemplo de código
curl -X PUT 'https://api.bird.com/workspaces/{workspaceId}/inbox/automation/new-item-reply' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'