API keys and webhooks
See how to create an API key and a webhook in NextSign, so your own systems can create cases and be notified when they're signed.
NextSign0:58
With NextSign's API, your own systems can create and send cases, and with webhooks they're notified when something happens, such as a case being signed. You need an API key and an address the webhook can send to.
The video shows how to create both. Below, the steps are described.
How to do it
- Create an API key. Under API keys, click "Create" and name the key, for example after the system that will use it.
- Keep the key. The key is shown only once. Copy it and keep it somewhere safe, such as your system's secrets.
- Create a webhook. Under Webhooks, click "Create". Name the webhook, choose the events that should notify you and enter the address the message is sent to.
- Test the webhook. Choose "Send test" in the menu next to the webhook, pick an event and a case, and send the test. You see straight away whether the message was delivered.
Good to know
- Create one key per system, so you can delete one key without affecting the others.
- Under See runs, you see the latest messages the webhook sent and whether they were delivered.
- If your system needs to know the sender, NextSign's IP address for allowlisting is on the Webhooks page.
Questions and answers
What if a key was shared by mistake?
Delete the key under API keys and create a new one. The old one stops working.
Which events can a webhook notify about?
Among others when a case is created, when a recipient has signed, when everyone has signed, when a case is rejected and when a delivery has failed.
Where do I find the API documentation?
Under API documentation in the menu at the bottom left.
