There are lots of URL parameters you can pass to https://pactsafe.io/send.
Want to send your calls to pactsafe.io/send
on the back-end? Then you may want to customize the URL parameters that you send so Ironclad Clickwrap tracks the right metadata about your acceptance/transaction. You can use either the short or long parameters.
Here are all the parameters you can use:
Short Parameter | Long Parameter | Description | Recommended |
---|---|---|---|
sid | site_id | The Access ID of the Ironclad Clickwrap Site. | Yes |
et | event_type | The type of event (e.g.,. Agreed, Disagreed, Visited, Updated, or Sent. | Yes |
em | execution_method | The method of execution. For example: click_to_accept , clickthrough , manual_acceptance , esignature . | Yes |
sig | signer_id | The unique identifier of the Signer. | Yes |
vid | version | The ID of a Version of a Contract. | Yes |
cid | contract | The numeric ID of a Contract. | Yes |
gid | group | The numeric ID of a Group. | If using Groups during acceptance. |
gkey | group_key | The string key used for identifying a Group. | If using Groups during acceptance. |
cus | custom_data | Additional data that gets attached to the activity. The cus parameter should be a JSON obj. | Use as necessary |
pat | page_title | The title of the page where the Activity occurred. | Yes |
pau | page_url | The URL of the page where the Activity occurred. | Yes |
pad | page_domain | The domain of the page where the Activity occurred. | Yes |
pap | page_path | The path of the page where the Activity occurred. | Yes |
paq | page_query | The query params associated with the page URL where the Activity occurred. | Use as necessary |
hn | hostname | The hostname of the website where the Activity occurred. | Yes |
ref | referrer | The referrer of the page visit. | Yes |
addr | remote_address | The IP address of the user associated with the Activity. | Yes |
btz | browser_timezone | The browser's set timezone associated with the Activity. | Yes |
bl | browser_locale | The browser's set locale associated with the Activity. | Yes |
os | operating_system | The operating system being used associated with the Activity. | Yes |
env | environment | Whether the device is Desktop, Table, or Mobile. | Yes |
scd | screen_color_depth | The color depth retrieved by the browser. | Yes |
res | screen_resolution | The resolution of the screen retrieved by the browser. | Yes |
ts | timestamp | The timestamp of the Activity. Timestamp is in ISO 8601 format. | Yes |
rnd | render_data | Data to be rendered on the contract. The rnd parameter should be a JSON obj. | As needed. |
dyn | dynamic | Whether the contract could present data dynamically. | As needed. |
server_side | server_side | Indicates to Ironclad Clickwrap whether the API call was made server-side. | Yes, when sending via a backend service. |
slo | snapshot_location | The location key for the Snapshot Location that should be linked to this acceptance. | If tracking visual evidence (Snapshots) for acceptance. |