Next Matter provides a RESTful API to customers and the full technical documentation can be found at https://core.nextmatter.com/api/docs/
To get started you need an API-Key, which customers can request from our support team. The API-Key can be either tied to an individual user in your workspace or to a Bot User that is created for that purpose.
The two most popular endpoints are
- /instances
- /complete_step
Header configuration
Content-Type: application/json
Authorization: Api-Key [PROVIDEDKEY]/instances
Endpoint: https://core.nextmatter.com/api/instances/
Simple sample body to launch a new instance of a process without tags, priority or deadline set.
{
"process": "https://core.nextmatter.com/api/processes/[IDoftheprocessinNM]/",
"name": "[Name of the instance]"
}/complete_step
Endpoint: https://core.nextmatter.com/api/instances/{{instance_id}}/complete_step/
The instance id can be retrieved in various ways, for example
- URL of the instance in the Browser
- Data referencing variable directly in Next Matter via {{instance_id}} in the editor
- GET requests or a response from the creation of an instance like in the previous example
Sample Body für die Vervollständigung eines String Input Felds
{
"step_id": 20111,
"actions": [
{ "action_id": 50222,
"input_object": {
"inputValue": "[STRING]"
}
}
]
}The step IDs can be retrieved directly in the URL of the executor or the editor. The action ids can be retrieved via GET Request.
Additional prerequisites for a successful call:
- Active step
- Step ownership of the user API-Key
Customers are making these calls also with third party integration layers like Zapier or Integromat.
This is an advanced functionality of Next Matter that is only sketched briefly in this article. Please reach out to us directly if you have any further questions around integrating your existing (propietary) apps seamlessly with Next Matter.
During our onboarding we usually guide our customers to setup their integrations with existing systems.