Zendesk Conversations icon

Zendesk Conversations

Handle messaging conversations through Zendesk Conversations.

2 triggers11 searches22 actionsInstant (webhooks)Auth: API key

AI-assisted documentation10 min read

This documentation is compiled from our integration source code, internal specs for Zendesk Conversations, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Zendesk Conversations on WEXTL →

To use Zendesk Conversations on WEXTL you need an active account and an API access token from your account settings.[3]

  • Zendesk - SubdomaintextRequired

    Login into your Zendesk account and copy your domain from your browser tab.

    [1]
  • Key IDtextRequired

    In Admin Center → Apps and integrations → APIs → Conversations API, click Create API key and enter a name. After clicking Next, copy the Key ID and Secret Key from the shared-secret dialog.

    [1]
  • Key SecretpasswordRequired

    Copy the secret from the recenlty obtain credentials

    [1]
  1. Log in to your WEXTL account, add the Zendesk Conversations node module to your workflow, and click Create new credential.
    Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Zendesk Conversations account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch ConversationsTrigger
Output fields[3]
FieldType
IDtext
Typetext
Is defaultboolean
Last updated atdate
Created atdate
Watch EventsTrigger
Output fields[3]
FieldType
App IDRequired
text
Integration IDRequired
text
TriggersRequired
choice
Get a ConversationAction
Input fields[3]
FieldType
App IDRequired
choice
Output fields[3]
FieldType
IDtext
Typetext
Is defaultboolean
Last updated atdate
Created atdate
Get a UserAction
Input fields[3]
FieldType
App IDRequired
text
Output fields[3]
FieldType
IDtext
External IDtext
Brand IDtext
Signed up atdate
Has payment infoboolean
Identitiesarray
Profileobject
Localetext
Locale origintext
Metadataobject
Get an AppAction
Input fields[3]
FieldType
App IDRequired
choice
Output fields[3]
FieldType
IDtext
Display nametext
Settingsobject
App localization enabledboolean
Echo postbackboolean
Mask credit card numbersboolean
Multi convo enabledboolean
Use animal namesboolean
Get an IntegrationAction
Input fields[3]
FieldType
App IDRequired
choice
Output fields[3]
FieldType
IDtext
Typetext
Statustext
Display nametext
List AppsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Display nametext
Settingsobject
App localization enabledboolean
Echo postbackboolean
Mask credit card numbersboolean
Multi convo enabledboolean
Use animal namesboolean
List ClientsSearch
Input fields[3]
FieldType
App IDRequired
text
Limitnumber
Output fields[3]
FieldType
IDtext
Typetext
Statustext
Last seendate
Linked atdate
List ConversationsSearch
Input fields[3]
FieldType
App IDRequired
choice
User IDchoice
User External IDtext
Limitnumber
Output fields[3]
FieldType
IDtext
Typetext
Is defaultboolean
Last updated atdate
Created atdate
List IntegrationsSearch
Input fields[3]
FieldType
App IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Typetext
Statustext
Display nametext
List MessagesSearch
Input fields[3]
FieldType
App IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Receiveddate
Authorobject
Typetext
Avatar URLurl
Contentobject
Typetext
Texttext
Sourceobject
Typetext
List ParticipantsSearch
Input fields[3]
FieldType
App IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
User IDtext
Unread countnumber
Client associationsarray
List UsersSearch
Input fields[3]
FieldType
App IDRequired
choice
User's Emailemail
Limitnumber
Output fields[3]
FieldType
IDtext
External IDtext
Zendesk IDtext
Brand IDtext
Signed up atdate
Has payment infoboolean
Identitiesarray
Profileobject
Localetext
Locale origintext
Metadataobject
Create a ClientAction
Input fields[3]
FieldType
App IDRequired
text
Output fields[3]
FieldType
IDtext
Integration IDtext
Typetext
Statustext
Create a ConversationAction
Input fields[3]
FieldType
App IDRequired
choice
Display NameRequired
text
TypeRequired
choice
Participantsarray
Subscribe SDK Clientboolean
Descriptiontext
Icon URLurl
Metadataarray
Output fields[3]
FieldType
IDtext
Typetext
Is defaultboolean
Last updated atdate
Created atdate
Create an AppAction
Input fields[3]
FieldType
Display NameRequired
text
Settingsobject
Conversation Retention Secondsnumber
Mask Credit Card Numbersboolean
Use Animal Namesboolean
Echo Postbackboolean
Ignore Auto Conversation Startboolean
Multi Conversation Enabledboolean
App Localization Enabledboolean
End Session Enabledboolean
Disable Conversation Reopenboolean
Metadataarray
Output fields[3]
FieldType
IDtext
Display nametext
Settingsobject
App localization enabledboolean
Echo postbackboolean
Mask credit card numbersboolean
Multi convo enabledboolean
Use animal namesboolean
Create an IntegrationAction
Input fields[3]
FieldType
App IDRequired
choice
TypeRequired
choice
Project IDRequired
text
Client EmailRequired
email
Private KeyRequired
text
Display Nametext
Can User See Conversation Listboolean
Can User Create More Conversationsboolean
Default Responder IDtext
Show AI Disclaimerboolean
Output fields[3]
FieldType
IDtext
Typetext
Statustext
Display nametext
Delete a ConversationAction
Input fields[3]
FieldType
App IDRequired
choice
Delete a MessageAction
Input fields[3]
FieldType
App IDRequired
choice
Delete a UserAction
Input fields[3]
FieldType
App IDRequired
text
Delete All MessagesAction
Input fields[3]
FieldType
App IDRequired
choice
Delete an AppAction
Input fields[3]
FieldType
App IDRequired
choice
Delete an AttachmentAction
Input fields[3]
FieldType
App IDRequired
choice
Media URLRequired
url
Delete an IntegrationAction
Input fields[3]
FieldType
App IDRequired
choice
Download Message RefAction
Input fields[3]
FieldType
App IDRequired
choice
User IDRequired
choice
Appleobject
Interactive Data ReferenceRequired
object
Join a ConversationAction
Input fields[3]
FieldType
App IDRequired
choice
User IDRequired
choice
Subscribe SDK ClientRequired
boolean
Output fields[3]
FieldType
IDtext
User IDtext
Unread countnumber
Client associationsarray
Leave a ConversationAction
Input fields[3]
FieldType
App IDRequired
choice
User IDRequired
choice
Make an API Calluniversal
Input fields[3]
FieldType
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Post MessageAction
Input fields[3]
FieldType
App IDRequired
choice
AuthorRequired
object
Author TypeRequired
choice
Author Subtypesarray
User IDchoice
User External IDtext
Brand IDtext
Display Nametext
Avatar URLurl
ContentRequired
object
Content TypeRequired
choice
Texttext
HTML Texttext
Block Chat Inputboolean
Markdown Texttext
Actionsarray
Payloadtext
Destinationobject
Integration IDchoice
Metadataarray
Overrideobject
Apple Message Override Payloadobject
Schematext
Limitnumber
Output fields[3]
FieldType
IDtext
Receiveddate
Authorobject
Typetext
Avatar URLtext
Contentobject
Typetext
Texttext
Sourceobject
Typetext
Remove a ClientAction
Input fields[3]
FieldType
App IDRequired
text
Output fields[3]
FieldType
IDtext
Integration IDtext
Typetext
Statustext
Update a ConversationAction
Input fields[3]
FieldType
App IDRequired
choice
Typechoice
Display Nametext
Descriptiontext
Icon URLurl
Metadataarray
Output fields[3]
FieldType
IDtext
Typetext
Is defaultboolean
Last updated atdate
Created atdate
Update a UserAction
Input fields[3]
FieldType
App IDRequired
text
To Be Retainedboolean
Profileobject
Given Nametext
Surnametext
Emailemail
Avatar URLurl
Localetext
Metadataarray
Output fields[3]
FieldType
IDtext
External IDtext
Brand IDtext
Signed up atdate
Has payment infoboolean
Identitiesarray
Profileobject
Localetext
Locale origintext
Metadataobject
Update an AppAction
Input fields[3]
FieldType
App IDRequired
choice
Display Nametext
Settingsobject
Conversation Retention Secondsnumber
Mask Credit Card Numbersboolean
Use Animal Namesboolean
Echo Postbackboolean
Ignore Auto Conversation Startboolean
Multi Conversation Enabledboolean
App Localization Enabledboolean
End Session Enabledboolean
Disable Conversation Reopenboolean
Metadataarray
Output fields[3]
FieldType
IDtext
Display nametext
Settingsobject
App localization enabledboolean
Echo postbackboolean
Mask credit card numbersboolean
Multi convo enabledboolean
Use animal namesboolean
Update an AttachmentAction
Input fields[3]
FieldType
App IDRequired
choice
SourceRequired
text
AccessRequired
choice
Forchoice
Output fields[3]
FieldType
Media URLurl
Media typetext
Update an IntegrationAction
Input fields[3]
FieldType
App IDRequired
choice
Typechoice
Project IDtext
Client Emailemail
Private Keytext
Display Nametext
Can User See Conversation Listboolean
Can User Create More Conversationsboolean
Default Responder IDtext
Show AI Disclaimerboolean
Output fields[3]
FieldType
IDtext
Typetext
Statustext
Display nametext

Look for Zendesk Conversations templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Zendesk Conversations Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Zendesk Conversations.
  4. WEXTL® visual workflow builder data.

Last updated: Aug 15, 2026 01:43