API Reference

Oct 26, 2020

About GraphQL

GraphQL is a query language that enables you to define precisely the data you want.

Learn more about GraphQL »

Learn about the Pipeline GraphQL API, how to authenticate, and how to execute the GraphQL queries and mutations.

Getting started

Authenticate your API calls

In order to maintain security and governance for our users and their data, Pipeline requires all API calls to be authenticated. The authentication is based on an OAuth token for the Pipeline user you're acting on behalf of.

This means you are limited to the visibility, governance, and actions based on the OAuth token for the user. Pipeline does not allow global access to all users and all data. In addition, any actions executed via API (i.e. complete step) will be logged as executed as that user.

Connect to API endpoint

For security, the API endpoint Url is based on your instance.

https://[yourinstance].pipelineapp.io/app/graphql/api/
Test your connectivity

Once you have your OAuth token, you can test your connectivity by using the standard me GraphQL query.

curl --request POST 'https://[yourinstance].pipelineapp.io/app/graphql/api/' 
--header 'Content-Type: application/json' 
--header 'Authorization: Bearer [token]' 
--data-raw '{
    "operationName": "MeQuery",
    "query": "query Me {
    	me {
            contactFirstName
            contactLastName
            contactEmail
    	}
    }",
    "variables": {}    
}'
{
  "data": {
    "me": {
      "contactFirstName": "Daniel",
      "contactLastName": "Payton",
      "contactEmail": "daniel.payton@company.com"
    }
  }
}

Next Steps

Build common use-cases

The vast majority of your calls will most likely be based on common use-cases. We've documented what they are and provided code samples for the GraphQL queries and mutations. Build out these common use-cases, and you'll have a great foundation for your integration.

Learn more about the common use-cases »

Learn GraphQL schema

The Pipeline API is based on the GraphQL schema, which has 3 main components: types (objects), queries, and mutations:

Types

A GraphQL type represents an object and the fields it has.

Learn more about the Pipeline API Types »

 Queries

A GraphQL query retrieves type(s) from a server, similar to a GET request in REST.

Learn more about the Pipeline API Queries »

 Mutations

A GraphQL mutation creates or modify type(s), similar to a POST, PUT, or DELETE request in REST.

Learn more about the Pipeline API Mutations »