BoldSignDocumentation
BoldSign Mobile Icon

Setting up webhook in your account

Mon, 24 January, 2022

APP level webhook

To create an app level webhook, first you need OAuth application to which the webhook will be tied to.
Go to the OAuth Apps page under the API section and click the Create Your First APP button.

oauth_app.png

You can choose to create developer application in both sandbox and live mode. Once you have tested your webhook in Sandbox mode you can choose Live mode for using it in your production. The option for creating the application can be toggled in create application window as shown below:

oauth_save.png

Once you have created an OAuth application, you can use that application to create webhook like below:

  • Go to the webhooks page under the API section and click the Add webhook button at the top right corner.

create-webhook.PNG

  • Choose to call back as APPs level.

Select APPs level.PNG

  • In the application drop down menu select the application you just created in the OAuth Apps section.

select_application.png

  • You can provide a webhook name. It will be useful for our personal identification and the purpose of a webhook to keep things organized.

webhook-name.PNG

  • You need to provide a webhook URL, to which BoldSign will notify when an event happens in your document. HTTPS URLs are required.

https-url.PNG

  • Once you have provided an URL, it needs to be verified to successfully register as a valid webhook. To verify a webhook simplify click the ‘Verify‘ button beside the URL textbox.

click verify button.PNG

  • When you click the “Verify” button, a HTTP POST request will be sent to your URL with below JSON payload. Note the “eventType” property value is “Verification”.

{
    "event": {
        "id": "7c872a5b-5fd5-4f1c-9765-92530a83a8b9",
        "created": 1617180024,
        "eventType": "Verification",
        "clientId": "17c97f7a-efdd-4fb5-b486-fef97b6544a7",
        "environment": "Test"
    }
}
  • NOTE: Your endpoint needs to respond with HTTP status code 200 OK within 10 seconds to be verified successfully. When the URL is successfully verified, you should see the acknowledgement like below in the modal.

url-verification-2.PNG

  • You can specify your actual endpoint URL instead of ngrok created URL if you have already set up your endpoint to receive callbacks.
  • You can subscribe and listen to individual event or all the events that happens in a document from a webhook.

trigger-events.PNG

  • Once you have completed all the above steps, you are now ready click ‘Save’ and create a webhook like below.

submit-form.PNG

Account Level Webhook

  • Go to webhooks page under API section and click the ‘Add Webhook’ button at the top right corner.

create-webhook.PNG

  • Choose to call back as APPs level

account level.PNG

  • You can provide a webhook name. It will be useful for our personal identification and the purpose of a webhook to keep things organized.

Enter account name.PNG

  • You need to provide a webhook URL, to which BoldSign will notify when an event happens in your document. HTTPS URLs are required

verify account url.PNG

  • Once you have provided an URL, it needs to be verified to successfully register as a valid webhook. To verify a webhook simplify click the ‘Verify’ button beside the URL textbox.

Verified url-1.PNG

  • When you click the “Verify” button, an HTTP POST request will be sent to your URL with the below JSON payload. Note the “eventType” property value is “Verification”

{
    "event": {
        "id": "7c872a5b-5fd5-4f1c-9765-92530a83a8b9",
        "created": 1617180024,
        "eventType": "Verification",
        "environment": "Test"
    }
}
  • NOTE: Your endpoint needs to respond with HTTP status code 200 OK within 10 seconds to be verified successfully. When the URL is successfully verified, you should see the acknowledgement like below in the modal.

Verified url-1.PNG

  • You can specify your actual endpoint URL instead of ngrok created URL if you have already setup your endpoint to receive callbacks.
  • You can subscribe and listen to individual event or all the events that happens in a document from a webhook.

trigger-events.PNG

  • Once you have completed all the above steps, you are now ready click ‘Save‘ and create a webhook like below.

submit account level.PNG

Copied to clipboard