Partners

Creates or updates the callback URL for a specific partner notification type. Use this to configure webhook destinations. Validation ensures the partner exists and the notification type is supported.

Deletes the callback configuration for a specific partner and notification type. Removes the webhook subscription. Returns 404 if the callback configuration does not exist.

Retrieves a list of all configured callbacks for a specific partner. Returns all active webhook subscriptions and their details for the requested partner ID.

The rawBody should follow the following structure based on the notificationTypeID. The structure of the rawBody will vary depending on the notificationTypeID, and it is crucial to ensure that the incoming JSON adheres to the expected format for successful processing. Important: At least one of processUniqueId or simulationUniqueId is required, never both. If both are provided, a bad request response will be returned.

Note on Notification Types:

1. Type (WorkflowStateChange): Requires the following JSON structure:

Code
 
{
 // This is a GUID representing the unique identifier of the workflow process.
 "processUniqueId": "7c9e6679-7425-40de-944b-e07fc1f90ae7", 
 // This is a GUID representing the unique identifier of the simulation, which can be used for correlating workflow state changes with specific simulations.
 "simulationUniqueId": "394A9BD7-695E-4998-8761-583F0F17F717",
 // This is an integer representing the language ID for localization purposes.
 "WorkflowStateID": 9,
 // This is a string describing the workflow state change.
 "Description": "Waiting for documents"
}

2. Type (Notes): Requires the following JSON structure:

Code
 
{
 // This is a GUID representing the unique identifier of the workflow process.
"processUniqueId": "7c9e6679-7425-40de-944b-e07fc1f90ae7", 
 // This is a GUID representing the unique identifier of the simulation, which can be used for 
 "simulationUniqueId": "394A9BD7-695E-4998-8761-583F0F17F717"correlating notes with specific simulations.
 // This is a string representing the title of the note.
 "Title": "New Note",
 // This is a string representing the content of the note.
 "Description": "This is a new note added to the process.", 
}

3. Type (Document): Requires the following JSON structure:

Code
 
{
 // This is a GUID representing the unique identifier of the workflow process.
 "processUniqueId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",  
 // This is a GUID representing the unique identifier of the simulation, which can be used for correlating documents with specific simulations.
 "simulationUniqueId": "394A9BD7-695E-4998-8761-583F0F17F717",
 // This is a GUID representing the unique identifier of the document that can be used to notify without sending the DocumentContent.
 "DocumentGuid": "177699E7-1340-4868-93D8-7E5993C651E4",
 // This is a string representing the name of the document.
 "DocumentName" : "ABCDE.pdf",
 // This is a string representing the type of the document.
 "DocumentType" : "FINE",
 // This is the document itself in a byte array format.
 "DocumentContent" : "BASE64 Document"
}