Docusign Webhook POST API - how to get body?

RE: Docusign Webhook POST API - how to get body?

NewBegineer — Sat, 11 May 2024 04:44:15 GMT

Hi nish,

Could you please me in understanding the webhook connection steps and for events like Envelope complete we have to hits a web API in Appian to start a process model.

Iam trying since so long but I could able to complete.

RE: Docusign Webhook POST API - how to get body?

ian.nish — Fri, 03 May 2024 14:21:35 GMT

Hi Steph, how did you set up the webhook on the DocuSign side? I'm in the middle of creating this same thing on a project and struggling to get the Webhook to connect. Nevermind! Got it working :)

RE: Docusign Webhook POST API - how to get body?

Stefan Helzle — Thu, 25 Apr 2024 14:39:12 GMT

fromJson turns the JSON string into an Appian dictionary in which you can navigate using dot-notation

data.envelopeSummary.status

RE: Docusign Webhook POST API - how to get body?

StephK — Thu, 25 Apr 2024 14:33:44 GMT

OK, thanks for all the details and suggestions. I was able to get the entire body into the process either as the straight json, or converted using a!fromjson. Both of those options work to get the text into a variable. BUT, I'm still not able to figure out how to parse and extract fields. (I did accomplish the same by using regex patterns, but that's not the best approach for a formatted file!).

I wonder if it's b/c the json is nested into sections? how would I notate the extract as the json looks like this - I need the object / data / envelopeId:

Thanks again for the help!

RE: Docusign Webhook POST API - how to get body?

Stefan Helzle — Thu, 25 Apr 2024 05:59:01 GMT

That has the drawback that, in case the JSON is invalid, you have a failed process instance you need to take care of.

I try to add input data validation code directly to the API to only start further processing if the incoming data is good.

RE: Docusign Webhook POST API - how to get body?

SRINIVAS M — Thu, 25 Apr 2024 04:31:47 GMT

Hi,

In your Appian process model, create a variable of type Text or dictionary to receive the raw JSON payload. Modify your Web API to pass http!request.body directly into the process variable you created.. In your process model, parse the JSON from the Text variable into a Dictionary using a!fromJson() within a Script Task.and after parsing, extract envelopeId and documentId from the Dictionary variable in subsequent Script Tasks or Gateways.

a!startProcess(
processModel: cons!WMO_Docusign_Receive,
processParameters: { jsonText: http!request.body },
onSuccess: a!httpResponse( /* success response */ ),
onError: a!httpResponse( /* error response */ )
)

And in your process model, you would have a parameter, let's say jsonText, to capture the raw JSON. Then, in the first Script Task.

local!jsonData: a!fromJson(local!jsonText),
local!envelopeId: local!jsonData.envelopeId,
local!documentId: local!jsonData.documentId

---By doing this, the process starts with the complete JSON payload, which you then parse and manipulate within the process model.

if this solution is not working , please ignore

RE: Docusign Webhook POST API - how to get body?

Mathieu Drouin — Wed, 24 Apr 2024 23:39:48 GMT

I would actually suggest not doing a!fromJson before starting the process (in the odd event that there is something wrong with the json that was sent) that prevents the process from starting.

Have one start parameter for your process (i.e. json) and parse the json using a!fromJson in a script task.

RE: Docusign Webhook POST API - how to get body?

Stefan Helzle — Wed, 24 Apr 2024 18:23:24 GMT

I understand. I think the example code is a bit ... unfortunately chosen.

It just passes the decoded JSON structure to the process. Now, the process model needs to provide multiple process variables, configured as parameters, to accept the individual top level values.

So, if the JSON response looks like this:

{
  "alpha": "one",
  "beta": {
    "one": 1,
    "two": 2
  },
  "gamma": 12345
}

... your process needs three parameter variables alpha, beta and gamma of the types Text, Map and Integer.

You could also change the code in the API to pass the whole structure into a single variable.

processModel: cons!WMO_Docusign_Receive,
processParameters: {
  your_process_variable: a!fromJson(
    http!request.body
  )
}

... then create one process variable named "your_process_variable" of type Map and make it a parameter.

RE: Docusign Webhook POST API - how to get body?

StephK — Wed, 24 Apr 2024 18:11:52 GMT

And if I manally paste the Docusign http body into my API configuration Test screen, it does convert it properly. I just don't know how to access that in the process.

RE: Docusign Webhook POST API - how to get body?

StephK — Wed, 24 Apr 2024 18:09:57 GMT

here's the code that came with the start process Web Api. I see the http!request body is supposed to get populated into the processParameters dictionary, but I can't figure out how to access it from there.

By "Start Trigger Panel", I was playing with the Start options in the process, to see if I was supposed to configure the message body into something there.

a!startProcess(
processModel: cons!WMO_Docusign_Receive,
processParameters: a!fromJson(
    http!request.body
),
onSuccess: a!httpResponse(
    statusCode: 200,
    headers: {
      a!httpHeader(name: "Content-Type", value: "application/json")
    },
    body: a!toJson(
      fv!processInfo
    )
),
onError: a!httpResponse(
    statusCode: 500,
    headers: {
      a!httpHeader(name: "Content-Type", value: "application/json")
    },
    body: a!toJson(
      {
        error: "There was an error starting the process"
      }
    )
)
)

RE: Docusign Webhook POST API - how to get body?

Stefan Helzle — Wed, 24 Apr 2024 17:53:18 GMT

When you follow the built in Web API example "Start Process", most of the things should already be set up. Can you share the code of the web API Appian object?

Not sure what you mean with "Start Trigger Panel" ...