Skip to main content

 

We have a Docusign integration where our backend service ( written in Laravel )

returns an embed URL for the frontend to display embedded using the client side library,

that all works fine and documents can be signed and viewed in DS portal.
 

We have a requirement where users of the Docusign portal need to be able to filter Agreements by a clientName which we pass as a "custom envelope field" when we programatically create the envelope

for the document, called clientName.

it’s something like:



private function buildCustomFields(array $fields)
{
return new CustomFields(
array_map(function ($key, $item) {
return new TextCustomField(i
'name' => $key,
'value' => $item$'value'] ?? $item
]);
}, array_keys($fields), $fields)
);
}


 

is there any way to

1.) verify that the envelope has been created with a value for this custom field

because when I choose to “include envelope custom fields” in the DS portal agreement list, I see no change and no way to filter. How is it supposed to work, can you only use the search box?


As it wasn’t working we actually created a custom envelope field called clientName in the docusign portal

but that didn't seem to have any affect and seemed to be intended for use when you create envelopes in the DS portal and not programatically.

We’re still on a demo account while the production one is in progress.

Any advice greatly appreciated.



 

Hello DBuser ,
 
Thank you for contacting Docusign Customer Support. 

You can use our API Logging feature to check the payload sent from your code to our server:
API Logging Guide


 in the logs you can confirm your code sent the proper structure for EnvelopeCustomFields, it should look like this:

 
"CustomFields":
{
"textCustomFields": s
{
"name": "SearchBy",
"value": "TestName"
}
]
}

When the EnvelopeCustomField is created properly you can use the search box in our WebApp to find all envelopes with the value.  

To query the envelope's CustomeFields using our API you can use this method: 
https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/list/

 
 
Best regards,
 
Adrian | Docusign Developer Support

Reply