Zapier
Plugboard works with Zapier through webhooks in both directions. There is no Plugboard app in the Zapier directory, so you use Zapier’s own webhook steps. Webhooks by Zapier needs a paid Zapier plan.
Both directions are part of external flows and hooks, which has the full detail. Neither works in the demo.
A flow starts a Zap
Section titled “A flow starts a Zap”- In Zapier, start a Zap with the Catch Hook trigger from Webhooks by Zapier and copy its webhook URL.
- In Plugboard, open Flows, Connections and choose Add a
connection. Paste the URL as the Address. This needs
flow.publish,integration.manageandconnector.manage, and asks you to confirm it is you. - Under What it may be sent, tick only what the Zap needs: Ticket text, Names and addresses or Anything about students. Ids and plain details are always allowed.
- In any flow, add a Start an external flow step, choose the connection, and name the values it sends. Each name becomes a field in the Zap.
Things to know:
- A Zap’s webhook URL is its only protection: Zapier checks nothing else. Plugboard keeps the URL sealed and shows only its host and last four characters after you save it. Keep it out of shared documents too.
- The body also carries
plugboard, with the run’s id (runId) and the flow’s name (flow), so the Zap can say which run it answers about. - Each request carries an
Idempotency-Keyheader that stays the same on every attempt of one step, and Standard Webhooks signature headers if Sign what it sends is on. Zapier does not check signatures; leave signing on unless the Zap refuses unknown headers. - A list sent in one request starts one Zap run for each item.
- The body is limited to 64 KB, and the Zap has 10 seconds to accept it.
- To get a result back, turn on Wait for its answer. The request then
carries a
callbackUrl; end the Zap with a Webhooks by Zapier POST to that URL with a JSON object. It works once, and expires when the step gives up.
For desk events without a flow (a ticket raised, a loan returned), you can also point an outbound webhook at a Catch Hook URL.
A Zap starts a flow
Section titled “A Zap starts a flow”- Build a Plugboard flow with the trigger Another app calls it. Under What it sends, list the values the Zap will send.
- Once the flow is saved, choose Add an address under Addresses. Name
it “Zapier”. Copy the address and the token: the token starts
pbh_and is shown once. This needsflow.publishandintegration.manage, with step-up. - In Zapier, add a Webhooks by Zapier Custom Request action:
- Method
POST, URL the address you copied. - Headers:
Authorizationset toBearerand the token,Idempotency-Keyset to a value unique to the event (such as the triggering record’s id), andContent-Typeset toapplication/json. - Data: a JSON object with the values the flow expects.
- Method
- Turn the flow on. Plugboard answers
202with the run’s id.
Limits on calls into Plugboard:
| Limit | Value |
|---|---|
| Requests per address | 60 a minute |
| Body size | 64 KB |
Idempotency-Key | Required, at most 200 characters, remembered for 72 hours |
| Signature | Optional per address; Zapier cannot sign, so leave Also require a signature off |
A repeat with the same Idempotency-Key starts nothing and answers with the
first run, so Zapier’s own retries are safe. What the Zap sends is marked “From
another app”: it can start the flow and appear in messages, but it never
chooses who or what a step changes without a person. To stop the Zap, revoke
its address; give each Zap its own address so one can be revoked without the
others.