Prior to 2022, Volt was known as Respond Flow. As we're making the transition to our new name, you may see technical details and domains that refer to Respond Flow throughout the documentation. Note that this is not a mistake, and no support for existing endpoints will be dropped for customers once the transition is complete.

To generate an access token, log in to your Volt account, navigate to Settings and click the Developers tab. If the tab is not available, be sure your user has proper permissions to manage users in Volt.

Each Volt webhook event that we send you will include a cryptographic signature in the X-Respond-Flow-Signature header. The signature allows you to validate that webhooks were not sent by a third-party. Our RSA public key is available at https://callbacks.respondflow.com/id_rsa.pub, which can be used to validate the signature sent with each request using a standard cryptographic library in your language of choice.

We strongly suggest using a GraphQL client library in the language of your choice when interacting with the Volt GraphQL API. Using a GraphQL client library will make it easier to take advantage of static typing, API schema introspection, and other features that let you quickly and reliably build into the Volt GraphQL API. For more information, check out What is a GraphQL client and why would I use one?.

Below is an example using python

Endpoint

You will use the API endpoint documented at the top of this page

url = "https://api.respondflow.com/graphql"

Headers

Your authorization will be your Bearer token

headers = {
    "Content-Type": 'application/json',
    "Authorization": "Bearer GENERATED_TOKEN"}

Variables

Where you see $variable: Type! in the examples, these should be passed beside the query

variables = {'primaryPhone':"+10003334444", 'phoneNumber': "+10000000464"}

Query Building

One of the benefits of GraphQL is that it will only return you the data you request, but this means that you must specify all the fields you need from the data. Where an example query may have many fields available

query contact(
     $primaryPhone: String!,
     $phoneNumber: String!
  ) {
    contact(
      primaryPhone: $primaryPhone,
      phoneNumber: $phoneNumber
    ) {
      id
      account {
        ...AccountFragment
      }
      organization {
        ...OrganizationFragment
      }
      phoneNumber
      name
      mappedNumber
      customFields {
        ...ContactCustomFieldFragment
      }
      createdAt
      lastUpdatedAt
      lists {
        ...ListFragment
      }
      blocked
    }
  }

You could reduce them to only the fields you want in the query

query contact(
  $primaryPhone: String!,
  $phoneNumber: String!
) {
  contact(
    primaryPhone: $primaryPhone,
    phoneNumber: $phoneNumber
  ) {
    name
    mappedNumber
    lastUpdatedAt
    blocked
  }
}

Similarly, the Contact object example has connected sub-objects (such as an Account attached to a Contact) and does not show all the fields of those sub-objects.

account {
        ...AccountFragment
      }

To get these sub-objects, you will need to expand their fields from linked types:

• AccountFragment->Account
• OrganizationFragment->Organization,
• ListFragment->List

query contact($primaryPhone: String!, $phoneNumber: String!) {
contact(primaryPhone: $primaryPhone, phoneNumber: $phoneNumber) {
  id
  account {
    id,
    createdBy,
    organization {
      id,
      companyName,
      domain,
      size,
      industry,
      createdAt,
      lastUpdatedAt,
      isOnFreeTrial,
      isActive},
    name,
    primaryPhone,
    createdAt,
    lastUpdatedAt,
    callForwardingNumber,
    location
  }
  organization {
          id,
          companyName,
          domain,
          size,
          industry,
          createdAt,
          lastUpdatedAt,
          isOnFreeTrial,
          isActive
  }
  phoneNumber
  name
  mappedNumber
  customFields {
    key
    type
    value
  }
  createdAt
  lastUpdatedAt
  lists {    
    id
    createdBy
    name
    createdAt
    lastUpdatedAt
    size
    querySourceListName
    queryNameSearchTerm
  }
  blocked
}
}

Expanding all the sub-objects can make it repetitive. You also may not care about every field for these sub-objects. You can reduce them just as you can the main fields in the query.

query_text = """
  query contact($primaryPhone: String!, $phoneNumber: String!) {
    contact(primaryPhone: $primaryPhone, phoneNumber: $phoneNumber) {
      id
      account {
        name,
        primaryPhone
      }
      organization {
        id,
        companyName
      }
      phoneNumber
      name
      mappedNumber
      createdAt
      lastUpdatedAt
      lists {    
        id
        Name
      }
      blocked
    }
  }
"""

Sending the Request

With all the above, we can now use a graphql library with an http transport to send this along

from gql import Client, gql
from gql.transport.aiohttp import AIOHTTPTransport
# Create a transport with the endpoint and headers
transport = AIOHTTPTransport(url=url, headers=headers)
# Create a GraphQL client using the AIOHTTPTransport transport
client = Client(transport=transport, fetch_schema_from_transport=True)
# Give gql the query
query = gql(query_text)
# Execute the query with variables
result = client.execute(query, variable_values=variables)
print(result)

The same can be achieved with the requests library, but note that querying requires a POST request

import requests
import json
response = requests.post(url=url, json={"query": query_text, "variables": variables}, headers=headers)
print("response status code: ", response.status_code)
if response.status_code == 200:
    content = json.loads(response.content)
    print(content['data'])
else:
    print(response.content)