Envelope

Envelope type — perform operations related to envelopes and their processing. Use it to find, fill, approve, delegate or initiate envelopes, resolve recipients, save or send envelopes, assign labels, and extract documents from envelopes.

envelope-flow-resolver

Replaces emails with auto-deposit mailboxes and checks if all mailboxes exist and are active.

{
  "type": "envelope-flow-resolver",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Replaces emails with auto-deposit mailboxes and checks if all mailboxes exist and are active\",\"type\":\"object\",\"properties\":{\"envelope\":{\"format\":\"uuid\",\"description\":\"ID of the envelope in the mailbox\",\"type\":\"string\"},\"mailbox\":{\"format\":\"uuid\",\"description\":\"ID of the mailbox\",\"type\":\"string\"}},\"required\":[\"mailbox\",\"envelope\"]}",
  "multipleInput": false,
  "outputParam": []
}

envelope-initiator

Initiates an envelope using data from a source file.

{
  "type": "envelope-initiator",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Initiates the envelope using data from the source file\",\"type\":\"object\",\"properties\":{\"envelope\":{\"format\":\"uuid\",\"description\":\"ID of the envelope in the mailbox\",\"type\":\"string\"},\"mailbox\":{\"format\":\"uuid\",\"description\":\"ID of the mailbox\",\"type\":\"string\"},\"map\":{\"description\":\"Template XPath to Source XPath/JsonPath mapping\",\"type\":\"object\"}},\"required\":[\"mailbox\",\"envelope\",\"map\"]}",
  "multipleInput": false,
  "outputParam": [
    "envelopeMetadata"
  ]
}

envelope-trigger

Finds envelopes using the configured envelope filters and provides the matching envelope and mailbox.

{
  "type": "envelope-trigger",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Envelope Trigger\",\"type\":\"object\",\"properties\":{\"template\":{\"description\":\"Set of template UUIDs associated with the envelope\",\"type\":\"array\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"}},\"sendDateFrom\":{\"format\":\"date-time\",\"description\":\"Start date for envelope send date filter\",\"type\":\"string\"},\"metadata\":{\"description\":\"Envelope metadata key-value pairs\",\"additionalProperties\":{\"type\":\"string\"},\"type\":\"object\"},\"createDateTo\":{\"format\":\"date-time\",\"description\":\"End date for envelope creation date filter\",\"type\":\"string\"},\"expireDateFrom\":{\"format\":\"date-time\",\"description\":\"Start date for envelope expiration date filter\",\"type\":\"string\"},\"subject\":{\"description\":\"Subject of the envelope\",\"type\":\"string\"},\"createDateFrom\":{\"format\":\"date-time\",\"description\":\"Start date for envelope creation date filter\",\"type\":\"string\"},\"expireDateTo\":{\"format\":\"date-time\",\"description\":\"End date for envelope expiration date filter\",\"type\":\"string\"},\"label\":{\"description\":\"Set of labels associated with the envelope\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"receiveDateTo\":{\"format\":\"date-time\",\"description\":\"End date for envelope receive date filter\",\"type\":\"string\"},\"form\":{\"description\":\"Set of form UUIDs to filter envelopes by\",\"type\":\"array\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"}},\"receiveDateFrom\":{\"format\":\"date-time\",\"description\":\"Start date for envelope receive date filter\",\"type\":\"string\"},\"sendDateTo\":{\"format\":\"date-time\",\"description\":\"End date for envelope send date filter\",\"type\":\"string\"},\"sender\":{\"description\":\"Set of sender UUIDs to filter envelopes by\",\"type\":\"array\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"}},\"recipient\":{\"description\":\"Set of recipient UUIDs to filter envelopes by\",\"type\":\"array\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"}},\"templateVersion\":{\"description\":\"Set of template version UUIDs associated with the envelope\",\"type\":\"array\",\"items\":{\"format\":\"uuid\",\"type\":\"string\"}},\"status\":{\"description\":\"Set of statuses to filter envelopes by\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}",
  "multipleInput": false,
  "outputParam": [
    "envelope",
    "mailbox"
  ]
}

envelope-saver

Saves an envelope in the specified mailbox.

{
  "type": "envelope-saver",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Envelope Saver\",\"type\":\"object\",\"properties\":{\"envelope\":{\"format\":\"uuid\",\"description\":\"ID of the envelope in the mailbox\",\"type\":\"string\"},\"mailbox\":{\"format\":\"uuid\",\"description\":\"ID of the mailbox\",\"type\":\"string\"}},\"required\":[\"mailbox\",\"envelope\"]}",
  "multipleInput": false,
  "outputParam": []
}

document-extractor

Extracts a specified document from an envelope.

{
  "type": "document-extractor",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Document Extractor\",\"type\":\"object\",\"properties\":{\"envelope\":{\"format\":\"uuid\",\"description\":\"ID of the envelope in the mailbox\",\"type\":\"string\"},\"mailbox\":{\"format\":\"uuid\",\"description\":\"ID of the mailbox\",\"type\":\"string\"},\"document\":{\"description\":\"ID of the document in the envelope\",\"type\":\"string\"}},\"required\":[\"mailbox\",\"envelope\",\"document\"]}",
  "multipleInput": false,
  "outputParam": []
}

envelope-approver

Approves an envelope in the specified mailbox.

{
  "type": "envelope-approver",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Envelope Approver\",\"type\":\"object\",\"properties\":{\"envelope\":{\"format\":\"uuid\",\"description\":\"ID of the envelope in the mailbox\",\"type\":\"string\"},\"mailbox\":{\"format\":\"uuid\",\"description\":\"ID of the mailbox\",\"type\":\"string\"}},\"required\":[\"mailbox\",\"envelope\"]}",
  "multipleInput": false,
  "outputParam": []
}

envelope-label-assignee

Assigns a label to an envelope.

{
  "type": "envelope-label-assignee",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Assign Envelope Label\",\"type\":\"object\",\"properties\":{\"envelope\":{\"format\":\"uuid\",\"description\":\"ID of the envelope in the mailbox\",\"type\":\"string\"},\"mailbox\":{\"format\":\"uuid\",\"description\":\"ID of the mailbox\",\"type\":\"string\"},\"label\":{\"description\":\"The name of the label\",\"type\":\"string\"}},\"required\":[\"mailbox\",\"envelope\",\"label\"]}",
  "multipleInput": false,
  "outputParam": []
}

envelope-filler

Fills an envelope in the specified mailbox.

{
  "type": "envelope-filler",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Envelope Filler\",\"type\":\"object\",\"properties\":{\"envelope\":{\"format\":\"uuid\",\"description\":\"ID of the envelope in the mailbox\",\"type\":\"string\"},\"mailbox\":{\"format\":\"uuid\",\"description\":\"ID of the mailbox\",\"type\":\"string\"}},\"required\":[\"mailbox\",\"envelope\"]}",
  "multipleInput": false,
  "outputParam": []
}

envelope-delegator

Delegates an envelope to another mailbox.

{
  "type": "envelope-delegator",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Assign Envelope Label\",\"type\":\"object\",\"properties\":{\"envelope\":{\"format\":\"uuid\",\"description\":\"ID of the envelope in the mailbox\",\"type\":\"string\"},\"mailbox\":{\"format\":\"uuid\",\"description\":\"ID of the mailbox\",\"type\":\"string\"},\"delegateTo\":{\"format\":\"uuid\",\"description\":\"Delegate mailbox ID\",\"type\":\"string\"}},\"required\":[\"mailbox\",\"envelope\",\"delegateTo\"]}",
  "multipleInput": false,
  "outputParam": []
}

envelope-sender

Sends an envelope from the specified mailbox.

{
  "type": "envelope-sender",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Envelope Sender\",\"type\":\"object\",\"properties\":{\"mailbox\":{\"format\":\"uuid\",\"description\":\"ID of the mailbox\",\"type\":\"string\"}},\"required\":[\"mailbox\"]}",
  "multipleInput": false,
  "outputParam": [
    "envelope"
  ]
}