English (US)
  1. Zendesk help
  2. Apps and integrations
  3. Apps and integrations documentation
  4. More integrations

Creating conversations integrations in Admin Center

Gary Beichler
  • Edited

What's my plan?

Suite Professional, Enterprise, and Enterprise Plus

Note:You must have aZendesk Suite Professional plan or aboveto create conversations integrations. Learn aboutSunshine Conversations pricingorContact Salesfor more information.

Conversations integrations help businesses unify messages from every channel, chatbot, or third-party app into a single conversation and build interactive experiences everywhere.

Conversations integrations are a bidirectional interaction between your business and Sunshine Conversations. The integration consists of:
  • A webhook.
  • (optional) A set of API keys to interact with the public API with a scope of integration. For information on creating the API keys, seeUsing Conversations API keys.

Note:Conversations integrations were formerly known aswebhooksin the Sunshine Conversations dashboard.

You can create conversations integrations through the Conversations Integrations page in Admin Center.

You can also create your integration using旋度orPostman.

This article includes the following sections:

Creating and configuring conversations in Admin Center

From the Conversations Integrations page, you can:

Creating a new conversation integration

To create a conversations integration in Admin Center
  1. InAdmin Center, clickApps and integrationsin the sidebar, then selectIntegrations > Conversations.The Conversations Integrations page opens. Any previously-created conversations appear in the list.

    If this is yourfirsttime creating an integration in Admin Center, clickCreate integrationto view the Conversations Integrations page.

  2. ClickCreate integration. The Create Integration page opens.
  3. Enter a unique name to identify the integration.
  4. In the Webhook section, enter the following information:
    • Webhook endpoint URL: The target URL. When a trigger event occurs, the webhook sees the event and sends the data to the target URL. The target URL uses the following format:https://www.yourdomain.com/path.
    • Webhook body data: Use the checkboxes to indicate whether you want to include the user schema and client and device information in the webhook data.
    • Webhook subscriptionst:选择事件hat you want to be notified on.
  5. ClickSave. The Copy shared secret window opens.
  6. (Optional) Copy the Webhook ID and Shared secret. These are used by developers to add another layer of authentication and are not required.
  7. ClickNext. The integration’s configuration page opens. From here you can add an API key, if necessary.

Adding an API key

On the API key tab, you can configure authentication for the integration. An API key identifies and authenticates an application or user and is composed of three pieces:

  • TheApp IDidentifies your Zendesk account.
  • TheKey IDwhen used together with the secret key are the credentials used to authenticate JWTs and API calls.
  • Thesecret keyis the authentication password.
Note:对话Integrati API密钥配置ons edit page are for custom integrations. They are scoped to a specific custom integration and cannot modify other integrations. For app-level API keys, see theSunshine Conversations Authentication page.

To create and share an API key

  1. InAdmin Center, clickApps and integrationsin the sidebar, then selectIntegrations > Conversations.The Conversations Integrations page opens.
  2. Click the API key tab.
  3. ClickCreate API key. If you are creating your first key, this button appears at the bottom of the page; if you have previously created a key, it appears in the top-right corner.
  4. Enter an identifying name for the key in the Create new key dialog, then clickNext.
  5. In the Copy shared secret dialog, clickCopyfor each ID and secret key to save it to your clipboard, then clickNext. You're returned to the API window, where the new key appears in the list.

If you generate a new key but have reached your 10-key limit, a notification appears, asking you to delete any unused keys.

To delete an unused key

  1. InAdmin Center, clickApps and integrationsin the sidebar, then selectIntegrations > Conversations.
  2. Click the API key tab.
  3. Hover your mouse pointer over the key you want to delete, then click the options menu () and select删除.
Confirm the action by clicking删除.

Viewing, editing, or deleting an integration

To work with an existing integration

  1. InAdmin Center, clickApps and integrationsin the sidebar, then selectIntegrations > Conversations.The Conversations Integrations page opens.
  2. Hover over the integration you want to update and click theOptions icon(), then select an option:
    • View details: Displays the integration's details page, where you can view the App, Integration, and Webhook IDs, as well as information on shared secrets, webhook details, and API keys.
    • Edit: Opens the Create Integrations page, where you can update the integration's name and webhook details.
    • 删除: Launches a deletion wizard. You can cancel and exit the wizard at any time.

Other integration methods

These methods are available only to users with a separate Sunshine Conversations license, not the license that comes with Zendesk Suite Professional or above.

To create a conversations integration using curl

  1. Create an integration using theCreate IntegrationAPI and settypetocustom.
  2. Provide the necessary parameters as specified in the API. The target is the URL of your server and the list of triggers determines which events to receive.

To create a conversations integration using Postman

  1. Create an integration using theCreate IntegrationAPI and settypetocustom.
  2. Download and install thePostmanapplication.
  3. Download the Sunshine ConversationsPostman collectionand set up your environment.
  4. In Postman, selectSmooch > Integrations > Create Integrations.
  5. Provide the necessary parameters as specified by your integration type.

For more information on the Sunshine Conversations APIs, seeIntegrations.

Also see the guides onsendingandreceivingmessages. You will want toconfigure webhooksusing REST APIs.

    Return to top

    5 Comments

    • Shameen Rana

      HiGary Beichler,

      Where does that integration/app go after creation?

      Like in sunshine dashboard we can see app and their linked integrations, does this app goes to some sunshine account that is linked to this support account?

      Kindly guide me the purpose of this feature.

      Thanks.

      0
    • Taylor Bowser
      Zendesk Customer Care

      HiShameen Rana,

      Thanks for your comment! After creation, the integration will be linked to the Sunshine Conversations app linked to your Zendesk subdomain. However, for new users this will only be accessible via the Conversations Integration page in the Admin Center.

      Only legacy Sunshine Conversation users will have access to the Sunshine Conversations dashboard.

      Hope this helps!

      0
    • Ahmed Zaid
      User Group Leader Community Moderator

      Hello,

      Is there a way or a plan for new users to access logs as legacy Sunshine Conversation users do?

      0
    • 嫁给简Dulay

      Error: "GraphQL server responded with error 3441003: please retry in some time or reach support to get the issue fixed"
      please help me to solve the WHATSAPP API Business Account creation error

      0
    • 嫁给简Dulay

      Error:

      WHATSAPP_BUSINESS_API_INBOX_ONBOARDING

      0

    Pleasesign into leave a comment.

    Powered by Zendesk