Developer Platform
  • Home
  • Getting Started
    • General Information
    • Features Overview
    • Security
  • APPs
    • Public Apps
      • Shopify
      • Salesforce
      • Zendesk
      • Google Analytics
    • Build your App
      • Getting started
      • My Apps
      • App information
      • App Parameters
      • App Plugins
      • Add Webhooks
      • Submit your Apps
      • App security
      • Developer Policy
  • Use Cases
    • Copilots
      • Product Catalog sync through API
      • FAQ sync through API
    • Visitor experience
      • Integrating custom buttons into your site
      • Check availability before escalating to iAdvize
      • Authenticated Messaging
        • Introduction
        • Web client-side implementation
          • Authenticated Messaging overview
          • Brief timeline of the integration process
          • How to enable authenticated mode in the administration portal?
          • How to implement the customer authentication backend (token provider)?
          • How to authenticate with iAdvize in client's website?
          • How to deal with activation success or failure?
          • How to logout?
          • Compatibility with Mobile SDK
          • FAQ
        • Web backend implementation
          • Important information and recommendations
          • Signature and Encryption Detailed Process
          • Technical backend implementation
          • FAQ
      • Cross-domain Conversation Continuity
      • Customize replies with Markdown
    • Agent workspace
      • Custom App example and step-by-step tutorial
        • Get Started
        • Work with the Desk
        • Intent / Trigger
        • JWT
        • References
    • Administration
      • Users
        • SAML SSO Authentication - Implementation Guide
        • Create, update and delete users via API
        • Manage the availability of your users with the iAdvize API
        • Integrate the iAdvize conversation panel into an existing tool
    • Data & Analytics
      • Anonymize a conversation or visitor data
      • Create a custom dashboard
      • Find contact data using GraphQL
      • Retrieve conversations data
      • Retrieve messages exchanged within a conversation
  • Technologies
    • GraphQL API
      • Terminology
      • Reference
      • Authentication
      • Schema lifecycle
      • Error Management
      • Pagination
    • REST API (deprecated)
      • Statistic (deprecated)
      • Group (deprecated)
      • Call meeting (deprecated)
      • Operator (deprecated)
      • Skill (deprecated)
      • Transaction (deprecated)
      • Visitor (deprecated)
    • Webhooks
      • Reference
      • Guides
    • Desk events
      • Reference
    • Web & Mobile SDK
      • Javascript Web SDK
        • Reference
      • Javascript Callbacks
        • Reference
        • Guides
      • Mobile SDK
        • Fourme (latest)
        • Epoisses
        • Dauphin
        • Cantal
        • 🤝Support Policy
        • 🤔Frequently Asked Questions
    • Custom App
    • External Bot
      • Implementation
        • Configuration flow
        • Conversation flow
        • Conversation objects
      • Configuration
      • FAQ
      • Best practices
Powered by GitBook
On this page
  • About iAdvize GraphQL API
  • API Root Endpoint
  • Building queries with GraphQL
  • Apollo

Was this helpful?

  1. Technologies

GraphQL API

PreviousRetrieve messages exchanged within a conversationNextTerminology

Last updated 6 months ago

Was this helpful?

About iAdvize GraphQL API

iAdvize GraphQL API offers flexibility and the ability to define precisely the data you want to fetch.

One of the powers of GraphQL API is to allow you to retrieve many resources in one HTTP call and to request only the fields you need.

If you want to learn more about GraphQL in general, please check the official .

It's useful to note that the official documentation also lists a .

API Root Endpoint

Our GraphQL API has a single endpoint: https://api.iadvize.com/graphql

The endpoint remains constant no matter what operation you perform.

If your environment is on the SD platform, your endpoint is: https://api.iadvize.com/graphql?platform=sd

The iAdvize GraphQL API is served over HTTPS.

Building queries with GraphQL

Because GraphQL operations consist of potentially voluminous JSONs, we strongly recommend using our . But, you can also use cURL or any other HTTP-speaking library.

While with REST we use HTTP verbs to define the operations to perform, in GraphQL we will use the HTTP POST verb. This is because you must provide a JSON-encoded body whether you are performing a query or a mutation.

Here is an example to list all the routing rules :


curl --request POST \
    --header 'content-type: application/json' \
    --header "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
    --url 'https://api.iadvize.com/graphql' \
    --data '{"query":"query {\n  routingRules {\n    id, name\n  }\n}","variables":{}}'

The string value of "query" must escape quotes and backslash characters or the schema will not parse it correctly.

Apollo

You can discover the schema and run queries on your iAdvize data using Apollo, an integrated development environment in your browser that includes the schema description, syntax highlighting, and validation errors.

If you want to know more about what can Apollo Explorer can do, you can checkout .

GraphQL documentation
comprehensive list of clients and other tools here
Apollo integration to create your GraphQL calls
Click here to use Apollo with our GraphQL api.
their documentation here