Integrating your own email or SMS provider

In this article we'll share how to set up integrations to your own SMS and email providers. You'll learn how to:

1. Catch a "Request Sent" webhook when a signature request is sent to your signer.
2. Learn how to process the webhook in order to include the right information in your email or SMS message.

What you'll need to get started

To get started with this guide, you'll need the following:

• API access
• Access and knowledge on setting up Webhooks
• A service or functioning endpoint for Ironclad Clickwrap Webhooks to reach out to (AWS' Lambda is great for things like this)

Primary data flows for integration

There are three primary data flows to consider when building your own integration to an email or SMS provider:

1. Catch a webhook when signature requests are sent to your signer
2. Catch a webhook when a signature request is signed by a signer
3. Catch a webhook when a signature request is completed by all parties

📘

Note: Reminders aren't scoped for this integration

Ironclad Clickwrap sends reminders when a signer hasn't signed after 3, 7, and 14 days. If you'd like to setup reminders, you'll also want to set up a recurring job that uses these reminders. Currently, there is no "Request Reminder" webhook but this is something we'll consider for the roadmap.

Getting started

You'll first want to set up a webhook with 3 events enabled: "Request Sent", "Request Signed", and "Request Complete". Click here to go to your Integrations, add a "Webhook", and follow the instructions here for more detail.

Next, you will want to build a dedicated service to catch webhooks fired by Ironclad Clickwrap in your own service and then handle accordingly.

🚧

Note: What if the webhooks fails to reach my own web service?

Failed webhook events will retry on a regular cadence for up to 24 hours should any failures occur.

1. Catch a webhook when signature requests are sent to your signer

If you're using the REST API to process signature requests in Ironclad Clickwrap, you're likely calling a POST to /requests/:request_id/send to deliver the finalized signature request to your signer(s). Upon doing this, Ironclad Clickwrap will trigger a webhook called "Request Sent" to any webhooks currently configured on the account.

Below are the 4 steps to your integration to deliver the SMS or email from your own provider.

GET => /v1.1/requests/:request_id{  "signers": [    {      "send_to": {          "email": true,          "mobile_number": true      },      "signer": {        "email": "[email protected]",        "mobile_number": "+13175551234"      }      "request_url": "..."  ]}

2. Catch a webhook when signature requests are signed by one of your signers

If you have more than one signer, you'll want to keep track of individual signers completing as they sign. Ironclad Clickwrap will trigger a webhook called "Request Signed" to any webhooks currently configured on the account every time any signer signs a signature request.

📘

Note: If you only have one signer

If you only have one signer on your signature request, Ironclad Clickwrap will send both a "Request Signed" and "Request Complete" (asynchronously, so not necessarily in order) for the final signature on the signature request.

Below are the steps to follow when a signature request is signed.

2. Catch a webhook when signature requests are completed by all signers

When the signature request is complete, you'll want to notify all signers via email or SMS with a link to review and download the signature request PDF. Ironclad Clickwrap will trigger a webhook called "Request Complete" to any webhooks currently configured on the account every time a signature request is completed.

Below are the steps to follow when a signature request is completed: