1
Click API keys & developer
Open Settings. Under INTEGRATIONS, click API keys & developer.
Want the full chapter? Integration Guide: Connectors and middleware (PDF) · API reference · All documentation
Find your API keys and the API reference
Do this when a developer or another system needs to read your data through the API.
2
Know where your API Key is
The top box holds your workspace API Key. Copy key copies it so you can paste it where it is needed. Treat it like a password; the key is hidden in this guide.
3
Know what Regenerate does
Regenerate makes a new key. Systems that use the old key stop working until you give them the new one.
4
Click + New key
Scoped API keys are keys limited to chosen kinds of records, so a system sees only what it needs. Click + New key to make one. The “i” icon explains scopes.
5
Use the API reference
API reference shows the address of the machine-readable description of the API. Copy address copies it. Webhooks next to it opens the webhooks list.
Set up a webhook
Do this to have BPMSquare call another system when something happens, or when someone presses a button on a record.
1
Click Webhooks
Under INTEGRATIONS, click Webhooks. All webhooks are in one list.
2
Read the list
Each row shows the Kind (Call or Event), the webhook and its address, its State, the Last call and Used by.
3
Check a row
The name and the method and host sit under Webhook. Click a row to open and change it.
4
Click + New webhook
Click + New webhook at the top right. A panel opens with two tabs, Basics and Request.
5
Type a Name
Give the webhook a name your team will recognise.
6
Choose the Kind
Call fires when something is awarded, a record button is pressed or a route runs. Event sends the change feed. The “i” icon explains each.
7
Choose what it Sends
Choose the kind of record the webhook sends, for example Accounts. For a Call you can tick Button on Accounts to add a button to that record.
8
Open the Request tab
The Request tab holds the address to call and how the call is made.
9
Click Create
Create saves the webhook. The On switch above it decides whether it is live straight away.
See how your ERP is connected
Do this to check which ERP is connected and which records flow between the two systems. This is the Integration middleware; the Connectors entry in the menu opens the same page.
1
Choose a connector
The chips at the top are your connectors, here Dynamics 365 and SAP S/4HANA. A green dot means connected. Click a chip to work on that connector.
2
Click + Add connector
+ Add connector adds another system. The “i” icon next to it explains what you can connect.
3
Read the setup line
A line such as Set up 4 of 5 · Next: open Links and save once shows how far the setup is and what to do next.
4
Open Links
Links lists each record type with its direction (an arrow to the ERP or from it), when it runs and an On switch.
5
Open Mapping
Mapping is where you match fields between BPMSquare and the ERP.
6
Open Monitor
Monitor shows the messages that went between the systems and whether they succeeded.
7
Open Resync
Resync sends records again when something needs to be repeated.
