mkdocs.yml

site_name: RingCentral Engage Developer Guide
site_url: https://engage-digital-api-docs.rtfd.org
site_favicon: favicon.ico
repo_url: https://github.com/ringcentral/engage-digital-api-docs
docs_dir: docs
theme:
  name: ringcentral
  product_section: engage
  fluid_layout: True
  suppress_nextprev: true
  shortcuts:
    - foo

plugins:
  - git-committers:
      repository: ringcentral/engage-digital-api-docs
      branch: master
  - bootstrap-tables

markdown_extensions:
  - markdown.extensions.admonition
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.tabbed
  - pymdownx.superfences
  - mdx_include
  - codehilite:
      linenums: "None"

extra_css: [extra.css]

nav:
- 'Primary':
  - 'Interactions':
    - 'Overview': interactions/index.md
    - 'Getting Started': interactions/quick-start.md
    - 'Web Messaging':
      - 'Overview': 'interactions/web-messaging/index.md'
      - 'Configuring the Community': 'interactions/web-messaging/community.md'
      - 'Configuring the Source': 'interactions/web-messaging/source.md'
      - 'Creating Catalog Items': 'interactions/web-messaging/catalog.md'
      - 'Chat Targeting': 'interactions/web-messaging/chat-targeting.md'
      - 'Email Notifications': 'interactions/web-messaging/email-notifications.md'
      - 'Integration to Target': 'interactions/web-messaging/integration.md'
      - 'Debug & Troubleshooting': 'interactions/web-messaging/debug.md'
      - 'Customization': 'interactions/web-messaging/customization.md'
      - 'JavaScript API': 'interactions/web-messaging/javascript-api.md'
      - 'Attachments': 'interactions/web-messaging/attachments.md'
      - 'Surveys': 'interactions/web-messaging/surveys.md'
    - 'Mobile Messaging':
      - 'Huawei Push Notifications': 'interactions/mobile-messaging/huawei-push-notifications.md'
    - 'Chatbots':
      - 'Overview': interactions/chatbots/overview.md
      - 'Implementation': interactions/chatbots/implementation.md
      - 'Replying to Messages': interactions/chatbots/replies.md
      - 'Creating Interventions': interactions/chatbots/interventions.md
      - 'Transferring to an Agent': interactions/chatbots/transfers.md
      - 'Closing Threads': interactions/chatbots/threads.md
      - 'Bots API': interactions/bots-api.md
    - 'Structured Messages':
      - 'Overview': interactions/structured-messages/index.md
      - 'Getting Started': interactions/structured-messages/quick-start.md
      - 'Select': interactions/structured-messages/select.md
      - 'List': interactions/structured-messages/list.md
      - 'Rich Link': interactions/structured-messages/rich-link.md
      - 'Template': interactions/structured-messages/template.md
      - 'Carousel': interactions/structured-messages/carousel.md
      - 'Time Select': interactions/structured-messages/time-select.md
      - 'Apple Form': interactions/structured-messages/apple-form.md
      - 'Apple Pay': interactions/structured-messages/apple-pay.md
      - 'Apple Authenticate': interactions/structured-messages/apple-auth.md
      - 'Webview': 'interactions/structured-messages/webview.md'
      - 'Webview SDK': interactions/structured-messages/webview-sdk.md
  - 'Routing':
    - 'Overview': routing/index.md
    - 'Getting Started': routing/quick-start
  - 'Digital':
    - 'Exports':
      - 'Overview': digital/exports/index.md
      - 'Main Export Fields': digital/exports/main-export-fields.md
      - 'Extensions Report Fields': digital/exports/extensions-report-fields.md
- 'Secondary':
  - 'Using the API':
    - 'Obtain an Access Token': basics/access-token.md
    - 'Requests': basics/requests.md
    - 'Responses and Errors': basics/responses.md
    - 'Authentication': basics/auth.md
    - 'Single Sign-on': basics/sso.md
    - 'Uploading Files': basics/uploads.md
    - 'Filters and Pagination': basics/pagination.md
    - 'User Impersonation': basics/impersonation.md
  - 'Events and Notifications':
    - 'Overview': webhooks/index.md
    - 'Creating Webhooks': webhooks/create.md
    - 'Receiving Events': webhooks/receive.md
    - 'Event Types': webhooks/events.md
  - 'SDKs':
    - 'Engage Digital SDKs and Sample Apps': sdks/index.md
    - 'App SDK':
      - 'Overview': sdks/app-sdk/index.md
      - 'Configuration and Development': sdks/app-sdk/config.md
      - 'Methods': sdks/app-sdk/methods.md
    - 'Channel SDK':
      - 'Overview': sdks/source-sdk/index.md
      - 'Getting Started': sdks/source-sdk/quick-start.md
      - 'Workflow': sdks/source-sdk/workflow.md
      - 'Polling': sdks/source-sdk/polling.md
      - 'Send API': sdks/source-sdk/send-api.md
      - 'Request/Response': sdks/source-sdk/request-response.md
      - 'Objects': sdks/source-sdk/objects.md
      - 'Actions': sdks/source-sdk/actions.md
      - 'Action Details': sdks/source-sdk/action-details.md
      - 'Options': sdks/source-sdk/options.md
      - 'Locales': sdks/source-sdk/locales.md
      - 'Structured Messages': sdks/source-sdk/structured-messages.md
    - 'Survey SDK':
      - 'Overview': sdks/survey-sdk/index.md
      - 'Getting Started': sdks/survey-sdk/quick-start.md
      - 'Authentication': sdks/survey-sdk/authentication.md
      - 'Configuration Fetching': sdks/survey-sdk/configuration-fetching.md
      - 'Responses Polling': sdks/survey-sdk/responses-polling.md
      - 'Realtime Responses Import': sdks/survey-sdk/realtime-responses-import.md
    - 'Embedded UI':
      - 'Overview': sdks/ui-embed/index.md
      - 'Views': sdks/ui-embed/views.md
      - 'Events': sdks/ui-embed/events.md
  - 'Postman': postman.md