Unions
#
ActorAn object that can act on other objects.
An agent is a user on Groove that is part of an organization.
To find all active agents, along with the teams they belong to, ordered by name:
To query for invited agents:
To reverse order the search:
To fetch agents ordered by the most times you assigned them to a conversation:
To fetch a single agent:
- A set of actions that will be performed on matching conversations.
To fetch all rules and their conditions:
By default rules are sorted by their user-defined row order. To sort by name instead:
#
Possible typesName | Description |
---|---|
Agent | An agent is a user on Groove that is part of an organization. To find all active agents, along with the teams they belong to, ordered by name. |
Contact | A contact contains the personal information associated with someone you have interacted with using Groove. They are identified by some unique contact detail such as an email address, a Twitter handle, or a phone number. This depends on how the contact was created. A contact is often a customer who initated a conversation. It could also be someone who was copied in on a conversation. |
Rule | Rules help you automate certain parts of your workflow. Each rule contains: 1. A set of conditions that match on incoming conversations, and; 2. A set of actions that will be performed on matching conversations. To fetch all rules and their conditions. |
#
AuthorAn object that can author things, for example messages or events.
An agent is a user on Groove that is part of an organization.
To find all active agents, along with the teams they belong to, ordered by name:
To query for invited agents:
To reverse order the search:
To fetch agents ordered by the most times you assigned them to a conversation:
To fetch a single agent:
#
Possible typesName | Description |
---|---|
Agent | An agent is a user on Groove that is part of an organization. To find all active agents, along with the teams they belong to, ordered by name. |
Contact | A contact contains the personal information associated with someone you have interacted with using Groove. They are identified by some unique contact detail such as an email address, a Twitter handle, or a phone number. This depends on how the contact was created. A contact is often a customer who initated a conversation. It could also be someone who was copied in on a conversation. |
#
ChangeTypeUnionAn object that can initiate a change.
#
Possible typesName | Description |
---|---|
AgentChanged | A conversation was reassigned to another agent. |
ChannelChanged | A conversation was moved to another channel. |
CommentDeleted | A comment was deleted. |
CommentEdited | A comment was edited. |
CommentReacted | A reaction was left on a comment. |
ContactChange | A conversation was reassigned to another contact. |
ContactOpenedMessage | A contact opened a message. |
ConversationDeleted | A conversation was moved to trash. |
ConversationMerged | A conversation was merged into another conversation. |
ConversationRestored | A conversation was restored from trash. |
ConversationStarred | The conversation was starred. |
ConversationUnstarred | The conversation was unstarred. |
EmailMessage | A message created in Groove as a result of an incoming email. Both contacts and agents can author these type of messages. For example, if an agent replies directly to a contact. |
FacebookMessage | A message sent to or received from Facebook. |
FollowerAdded | A conversation is followed by an agent. |
FollowerRemoved | A conversation is unfollowed by an agent. |
ForwardedMessage | A message forwarded by an agent from Groove to a third party. |
IntegrationAdded | An integration was added to a conversation. |
IntegrationExternalChange | A change to a conversation was triggered by a linked integration. |
IntegrationRemoved | An integration was removed from a conversation. |
MessageMoved | A message was moved from one conversation to start another. |
Note | A message created by an agent in Groove, visible only to other agents. |
Rating | A rating is feedback on a conversation message from a contact for an agent. |
Reply | An email message from an agent to a contact. |
ShopifyExternalChange | A change that happened on Shopify. |
Snoozed | A conversation was snoozed. |
StateChanged | The state of the conversation changed. |
SubjectChanged | A conversation subject was updated. |
Tagged | A tag was added to a conversation. |
TeamChanged | A conversation was reassigned to another team. |
TwitterMessage | A message sent to or received from Twitter. |
Unsnoozed | A conversation was unsnoozed. |
Untagged | A tag was removed from a conversation. |
WidgetMessage | A message received from a contact using the Widget. |
#
CustomFieldSubjectTypeAn object that can have custom fields applied to it.
#
Possible typesName | Description |
---|---|
Company | A company represents an organization containing one or more contacts. |
Contact | A contact contains the personal information associated with someone you have interacted with using Groove. They are identified by some unique contact detail such as an email address, a Twitter handle, or a phone number. This depends on how the contact was created. A contact is often a customer who initated a conversation. It could also be someone who was copied in on a conversation. |
#
DraftTypeUnionNo description
#
IntegrationUnionNo description
#
RecipientAn object that can receive email replies.
An agent is a user on Groove that is part of an organization.
To find all active agents, along with the teams they belong to, ordered by name:
To query for invited agents:
To reverse order the search:
To fetch agents ordered by the most times you assigned them to a conversation:
To fetch a single agent:
#
Possible typesName | Description |
---|---|
Agent | An agent is a user on Groove that is part of an organization. To find all active agents, along with the teams they belong to, ordered by name. |
Contact | A contact contains the personal information associated with someone you have interacted with using Groove. They are identified by some unique contact detail such as an email address, a Twitter handle, or a phone number. This depends on how the contact was created. A contact is often a customer who initated a conversation. It could also be someone who was copied in on a conversation. |
#
ValueTypeUnionAll possible custom field value types.
#
Possible typesName | Description |
---|---|
Address | A full address. |
File | A file attached to a contact or company. |
IpAddress | An IP address. |
Link | A text link. |
Money | A amount with the linked defined currency. |
Session | A contact visit session as recorded by the Widget. |
Text | A text string. It can represent either a single line, multiple lines, or an email. |
UserAgent | A characteristic string used to identify visitors. |