Set up triggers for the Docusign eSignature spoke

  • Release version: Yokohama
  • Updated January 30, 2025
  • 3 minutes to read

    • Set up the trigger to generate the callback URL on your ServiceNow instance.

    Before you begin

    • Request an Integration Hub subscription.
    • Activate and set up the Docusign eSignature spoke.
    • Role required: admin.

    Enable system property for client credentials grant type

    Create or enable the glide.oauth.inbound.client.credential.grant_type.enabled system property to use the OAuth client credentials grant type for inbound integrations from the Docusign OAuth client to ServiceNow instance.

    Before you begin

    Role required: admin

    About this task

    For more information about client credentials grant type, see Client Credentials.

    Procedure

    1. Navigate to All > System Properties > All Properties.
    2. Search for the glide.oauth.inbound.client.credential.grant_type.enabled system property.
    3. Open the record.
    4. For Value, enter true.
    5. Right-click the form header and click Save.

    Create an application registry to authenticate the inbound calls

    Create an application registry in the ServiceNow instance to authenticate the inbound calls.

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to All > System OAuth > Application Registry.
    2. Click New.
    3. Select Create an OAuth API endpoint for external clients.
    4. On the form, fill in the fields.
      Table 1. Application Registries form
      Field Description
      Name Name to identify the application registry record. For example, Docusign External Trigger.
      OAuth Application User User role to which the OAuth token flow is mapped.
      Important:
      By default, this field is not displayed on the Application Registries form. Configure the form layout to see the field on the form. For information about configuring the form layout, see Configuring the form layout.
    5. Right-click the form header and click Save.
      Application registry record is created and value of Client Secret is generated.

      Copy and record the values of Client ID and Client Secret for later use.

    Activate the trigger definition on ServiceNow instance

    Activate the trigger definition to generate the callback URL on your ServiceNow instance.

    Before you begin

    Role required: flow_designer and connection_admin.

    About this task

    Docusign uses the callback URL to securely send the payload to the ServiceNow instance.

    Procedure

    1. Navigate to All > Process Automation > Workflow Studio.
    2. Select the Integrations tab.
    3. Toggle and enable the Inbound tab.
    4. Locate the Docusign eSignature Spoke card and select View Details.
      Locate the Docusign eSignature Spoke card.
    5. Select Configure.
      Configure the endpoint.
    6. On the form, fill these values.
      Field Description
      Required roles Roles using which the flow will be triggered. For example, select admin.
      Application Registry Select the application registry you had created to authenticate inbound calls. For example, select Docusign External Trigger.

      Activate the endpoint.

    7. Click Activate.
      The endpoint is activated and the value of URL is generated.

      Copy and record the value of URL for later use.

      Copy the URL for later use.

    Add configuration in Docusign account

    Add a custom configuration in the Docusign account to send real‐time data updates to the ServiceNow instance.

    Before you begin

    Role required: admin

    Procedure

    1. Log in to the Docusign account as an admin.
    2. Click Admin.
    3. Navigate to Integrations > Connect.
    4. Under Configurations, click Add Configuration and select Custom.
    5. On the form, fill in the values.
      Field Description
      Name Name to identify the custom configuration record.
      URL to Publish Enter the URL that is generated when you activated the trigger definition in this format: https://<ServiceNow-instance-name>.service-now.com/api/sn_docusign_spoke/docusign_esignature_external_trigger.

      For more information, Activate the trigger definition on ServiceNow instance.
      Data Format Ensure that you select REST v2.1.
      Event Message Delivery Mode Select Send Individual Messages (SIM).
      Trigger Events Expand Envelope and Recipients and select these events:
      • Envelope Sent
      • Envelope Delivered
      • Envelope Signed/Completed
      • Envelope Declined
      • Envelope Voided
      • Envelope Deleted
      • Recipient Sent
      • Recipient Auto Responded
      • Recipient Delivered
      • Recipient Signed/Completed
      • Recipient Declined

      Triggers events to be selected.

      Under Include Data, select the Recipients option. Select other options as per your requirement.

      Select the Recipients option.
    6. Under Integration and Security Settings, select the Include OAuth (Recommended) check box.
    7. Click Add Configuration.
      The custom configuration record is created.
    8. Click Actions for the custom configuration record that you created and select Edit.
      Edit the custom configuration.
    9. Under Integration and Security Settings, click Manage OAuth.
      The OAuth 2.0 tab is displayed.
    10. Enter the values of Client ID and Client Secret.
      These values are created when you create application registry record in ServiceNow instance. For more information, see Create an application registry to authenticate the inbound calls.
    11. Enter Authorization Server URL in this format: https://<ServiceNow-instance-name>.service-now.com/oauth_token.do.
    12. Click Save.

    What to do next

    Create flows in Workflow Studio using these triggers as per your requirement. For more information, see Create a flow with an external trigger.