Package: helloworks-python-sdk
helloworks-python-sdk 🐍Easily create and manage HelloWorks workflow instances. 🚀Installationpip install helloworks-python-sdkInitial setupGo to your HelloWorks account and get your public key ID and your private key valueRemember to record the private key immediately and store it in a safe place. The private key value cannot be retrieved later, however keys can be generated at any time.See their docsfrom helloworks import HwClient
client = HwClient(api_key_id, api_key_value)Note: Tokens will be refreshed and managed internallyNote: Methods will return a dictionary of HW responseCreate a workflow instanceMethod to create an instance of a Workflow to send out to a user:workflow_id = 'IDs located in API request info'
# Participants is a dictionary of dictionaries
participants = {'participant_QIxDNu': {'type': 'email',
				       'value': 'kevteg05@gmail.com', 
				       'full_name': 'Kevin Hernandez'}}
# Merge fields is a dictionary of the available merge fields at Api request info
merge_fields = {'applicantName_f2GtnW': 'Kevin', 'jobTitle_WCUZlG': 'Test'}
response = client.create_workflow_instance(workflow_id, participants, merge_fields)See the full list of available fieldsPreview a workflow instanceMethod to create a preview instance of a Workflow to send out to a user:workflow_id = 'IDs located in API request info'
# Participants is a dictionary of dictionaries
participants = {'participant_QIxDNu': {'type': 'email',
				       'value': 'kevteg05@gmail.com', 
				       'full_name': 'Kevin Hernandez'}}
# Merge fields is a dictionary of the available merge fields at Api request info
merge_fields = {'applicantName_f2GtnW': 'Kevin', 'jobTitle_WCUZlG': 'Test'}
response = client.create_workflow_instance(workflow_id, participants, merge_fields)See the full list of available fieldsCancel a workflow instanceCancel a Workflow Instance that is currently activeworkflow_instance_id = 'ID returned by the creation of the workflow'
response = client.cancel_workflow_instance(workflow_instance_id)More infoGet a workflow instanceRetrieve information on a single Workflow Instanceworkflow_instance_id = 'ID returned by the creation of the workflow'
response = client.get_workflow_instance(workflow_instance_id)More infoGet Workflow Instance Document [After workflow is completed]Method to get a given document of a workflow instancedocument_id = 'You can get the documents IDs after the workflow is finished (Using get_workflow_instance method'
workflow_instance_id = 'ID returned by the creation of the workflow'
request = client.get_workflow_instance_document(workflow_instance_id, document_id, get_request=True)Note: By default this method will return the request, so you can do any process you might need with it, if you want the file to download in your directory use get_request=False instead.More infoGet Workflow Instance Audit Trail [After workflow is completed]Method to get the audit trail of a workflow instanceworkflow_instance_id = 'ID returned by the creation of the workflow'
request = client.get_workflow_instance_audit_trail(workflow_instance_id, get_request=True)Note: By default this method will return the request, so you can do any process you might need with it, if you want the file to download in your directory use get_request=False instead.More infoGet Workflow Instance Documents [After workflow is completed]Method to get the documents, in a zip file, of a workflow instanceworkflow_instance_id = 'ID returned by the creation of the workflow'
request = client.get_workflow_instance_documents(workflow_instance_id, get_request=True)Note: By default this method will return the request, so you can do any process you might need with it, if you want the file to download in your directory use get_request=False instead.More infoGet Workflow Instance StepsMethod to get the specified workflow instance, the step id, the role that will be completing the step,
the signer's full name, and the unauthenticated url that can be used to start entering information.workflow_instance_id = 'ID returned by the creation of the workflow'
response = client.get_workflow_instance_steps(workflow_instance_id)More infoGet Document LinkFor the specified workflow instance, get the step id, the role that will be completing the step, the signer's full name, and the unauthenticated url that can be used to start entering information.workflow_instance_id = 'ID returned by the creation of the workflow'
response = client.get_document_link(workflow_instance_id)More infoGet Authenticated Link for Workflow Instance's Step [Premium]Method to get the authenticated link for a workflow instance step, to use it you need to have delegated authentication enabled and have launched this specific workflow instance with delegate authentication activatedworkflow_instance_id = 'ID returned by the creation of the workflow'
step_id = 'You can get the step using the get_workflow_instance_steps method'
response = client.get_authenticated_link_for_workflow_instance_step(workflow_instance_id, step_id )Note: This link is active for only 30 secondsMore infoSave Settings with Logo FileNotImplementedJustYetErrorTODOsCreate custom exceptions to improve error handlingManage responses as objects similar to what HelloSign SDK doesImprove file managementSave settings with logo file