Task Event Subscriptions

There are two methods that are supported for notifying your application of these status change events: (1) HTTP POST, and (2) HTTP GET.

If using HTTP POST, data elements are sent via a standard HTTP(S) POST of urlencoded name value pairs as an “application/x-www-form-urlencoded” mime type. This is the same format used by standard HTTP form post actions, so most server side processors understand how to parse form posts.

For information about controlling event behavior, timeout settings, and retry configuration, see Webhook Configuration.

Status Change

You can subscribe to Task status change events by adding a Workflow Action to the Task.

Name	Value
TransID	The TransID is a standard 10 digit ID used for a transaction as discussed elsewhere. Example: `1234567890`
PartID	The PartID is a standard 10 digit ID used for a participant as discussed elsewhere. Example: `1234567890`
DocID	The DocID is a standard 10 digit ID used for a document as discussed elsewhere. Example: `1234567890`
TaskID	The TaskID is a standard 10 digit ID used for a task as discussed elsewhere. Example: `1234567890`
TaskStatus	The TaskStatus will be one of the following one-digit integer values: `2` Pending `4` Complete `7` Closed `8` Cancelled `9` Expired
TXStatus	The TXStatus will be one of the following one-digit integer values: `2` Pending `4` Complete `7` Closed `8` Cancelled `9` Expired `10` Voided
EventType	signature
ps_securitytoken	guid
SigID SigAccessToken SigStatus DocAccessToken	DEPRECATED

task = new TaskInsertModel()
        {
            WorkflowActions = new List<object>
            {
                new TaskWorkflowActionModel()
                {
                    Type = TaskWorkflowActionModel.TypeEnum.SubscribeToStatusChangeNotificationsByPost,
                    Data = "required-response-text=RECEIVED", // Note: timeout and retry parameters are now server-configured
                    Url = "https://myapp.mydomain.com/statuslistener.php"
                }
            }
        }

A completed participant from that uses the above code would see something like the following as the posted status notification values:

{
    "TransID": "1234567890",
    "TaskID": "1234567890",
    "TXStatus": 2,
    "TaskStatus": 4,
    "EventType": "signature",
    "ps_securitytoken": "4bf44fb0-f695-40b5-821d-c22273e11c30"
}

Likewise, if the participant was using a SubscribeToStatusChangeNotificationsByGet method type, the posted status notification value might look something like this:

https://myapp.mydomain.com/statuslistener.aspx?TransID=1234567890&TaskID=1234567890&TXStatus=2&TaskStatus=4&EventType=signature&ps_securitytoken=4bf44fb0-f695-40b5-821d-c22273e11c30