Skip to main content

​
API reference

Endpoints are grouped the way integrations use them: Context lookups, Actions and Triggers.
Paths are namespaced by provider. Every endpoint here lives under /integrations/developer/zapier, the namespace for the only provider supported today. Additional namespaces will follow when general API access opens up; the request and response shapes are designed to stay the same.

​
Using the playground

  1. Paste an OAuth 2.0 access token into the Authorization field. See Authentication for how tokens are issued.
  2. Fill in the body or query fields and send. Required fields are marked. developerProvider names the calling provider and is zapier for the endpoints listed here.

​
Zapier steps and their endpoints

Zapier is the only provider today, so a Zap’s task history is the most common place you’ll meet these endpoints. Each step is one request. Setup questions belong in the Zapier integration guide; this table is for matching a step to its reference page.

​
Reading the schemas

  • Names are prefixed with the internal package that defines them (developer., entities., enums.). The prefix has no meaning on the wire.
  • entities.* schemas are full records as MessageDesk stores them and include nested relationships. Context lookups return them; actions return the smaller developer.*Response shapes.
  • Fields typed as object with no properties accept or return arbitrary JSON, for example a contact’s custom properties.

​
Download