Note

Please refer to Webhook Fundamentals for more details on how to effectively use webhooks.

Container Submitted Webhook Callback

When a container has been submitted to the TrustID Cloud for processing, it can call your own webhook if it has been told to do so.

To identify a webhook of this type you should check for the following 2 request properties:

• CallbackInfo.WorkflowName Will have a value of AutoReferral.

• CallbackInfo.WorkflowState Will have a value of Start.

The following is an example request payload for this webhook:

{
  "Callback": {
        "Aborted": false,
        "CallbackAt": "/Date(1646838015063+0000)/",
        "CallbackId": "db051177-e0ab-4eb8-8bc6-4fdcbb5e9be1",
        "CallbackStatusCode": 0,
        "CallbackUrl": "https://webhook.site/78cf0673-2a95-48f3-9c2d-875cf42a66e3",
        "ErrorMessage": null,
        "ProcessName": "DataAccess.PublishDocumentContainer",
        "RetryCounter": 1,
        "ScheduledAt": "/Date(1646838005037+0000)/",
        "State": 5,
        "UpdatedAt": "/Date(1646838015037+0000)/",
        "WorkflowName": "AutoReferral",
        "WorkflowState": "Start",
        "WorkflowStorage": [
          {
                "Key": "ContainerId",
                "Value": "54eaaf9a-40a0-4e46-a156-d28299f3b6f3"
          },
          {
                "Key": "DocumentId",
                "Value": null
          },
          {
                "Key": "ClientApplicationReference",
                "Value": null
          }
        ]
  },
  "Response": {
        "AccessDenied": false,
        "CallbackId": null,
        "Locked": false,
        "Message": "Operation executed successfully.",
        "SessionExpired": false,
        "Success": true,
        "VpeUnreachable": false,
        "AutoReferred": false,
        "ContainerId": "54eaaf9a-40a0-4e46-a156-d28299f3b6f3",
        "DocumentReplaced": false,
        "MergeContainers": false,
        "Merged": false
  }
}

Note

Please refer to WebhookResponse. for more details.