The SignAndGo API and webhooks: an overview.
If your business runs its own software, such as a booking system, a CRM or an in-house job tool, you may want documents sent for signature without anyone opening SignAndGo. The API and webhooks are how your developers build that in.
What the API is for
The API lets your system do from code what a person would do in the app. A typical flow creates an envelope with a document and its signers, sends it, then later fetches the signed document once everyone has finished. Your staff keep working in the tool they already use, and the signing happens in the background.
What webhooks add
Checking every few minutes whether a document has been signed is wasteful. A webhook turns that around: you give SignAndGo an address in your system, and SignAndGo tells it when something happens to an envelope, such as a signer finishing or the whole envelope completing. Your system reacts straight away, for example by moving a job to the next stage.
Webhook messages are signed, so your system can check that each one genuinely came from SignAndGo before acting on it.
Jobs people build
- Send a service agreement automatically when a deal is marked won in a CRM.
- Send an inspection or job report for sign-off when a technician closes a job.
- Update a customer record the moment a contract completes.
- Store the signed document against the right record in your own system.
Keys and access
Build against test envelopes sent to your own team first, so a mistake in your code does not land in a customer's inbox. Once the flow works end to end, point it at real documents.
Access is by API key, with each key limited to what it needs, such as reading envelopes or sending them. Treat a key like a password: keep it in your system's secret settings rather than in code, and give each integration its own key so you can withdraw one without breaking the others.
Before you build
Map the documents and signers you want to automate, and decide which events your system needs to hear about. For API access and documentation, contact us at sign@signandgo.com.au with a short description of what you are building. If you only need signed documents filed into Xero, you may not need the API at all: the Xero connection does it without code.
Common questions
- Do I need a developer to use the API?
- Yes. The API and webhooks are for building SignAndGo into your own software.
- How does my system know a webhook is genuine?
- Each webhook message is signed, so your system can check it before acting.
- Can the API fetch the signed document?
- Yes. Once an envelope is complete, your system can download the signed document through the API.
- Is there a simpler option for Xero?
- Yes. Connect Xero in the app and signed documents can be filed there with no code.