Metadata lets you store your own information on an envelope as a set of key–value pairs. It's most useful for linking an Annature envelope to the matching record in your own software, such as a deal, client, job or matter.
Adding metadata
Include a metadata object when you create an envelope through the API. For example:
"metadata": {
"client_id": "C-10482",
"deal_id": "88123",
"source": "crm"
}Metadata is stored with the envelope and returned whenever you retrieve it.
Common uses
Matching records — store your own client, deal or matter ID so you always know which record an envelope belongs to.
Routing — record which office, team or workflow created the envelope, so your system can handle it correctly once it's signed.
Reporting — tag envelopes by product, campaign or source to report on them in your own system.
Using metadata with webhooks
Webhook events identify the envelope by its envelope_id, but don't include its metadata. To match an event to your records:
Receive the webhook event, for example
envelope_completed.Retrieve the envelope using the
envelope_idfrom the event.Read the
metadataon the envelope to find the matching record in your system.
Alternatively, save the envelope_id against your own record when you create the envelope, and look it up when the event arrives.
Tips
Use metadata for references, not sensitive information. Don't store passwords, tax file numbers or other personal information in it.
Keep key names consistent across your integration, so they're easy to search and report on.