Subscribe to UW Task events

API Method: POST /api/v1/uwTasks/subscribe

Description:

This API endpoint allows users to subscribe to events related to Underwriting (UW) tasks. Once subscribed, the system will send notifications to a specified callback URL whenever certain UW task events occur, such as status updates, task assignments, or completion. This subscription is set up for all merchants and is a one-time process that ensures you receive real-time updates on underwriting activities.

Request:

• HTTP Method: POST
• Endpoint: /api/v1/uwTasks/subscribe
• Content-Type: application/json

Request Body Parameters:

The request body must be in JSON format and include the following field:

• callbackUrl (required):
  The URL to which notifications or events related to UW tasks will be sent. This should be an active endpoint on your system that can handle the incoming event payloads.
  • Type: string
  • Example: "callbackUrl": "https://yourdomain.com/uwtask/events"

Response:

• Status Code:

  • 200 OK: If the subscription is successfully created.
  • 400 Bad Request: If the callbackUrl is missing or invalid.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  A confirmation message indicating the subscription was successful, along with details about the callback URL.

Example Request:

POST /api/v1/uwTasks/subscribe
Content-Type: application/json

{
  "callbackUrl": "https://yourdomain.com/uwtask/events"
}

Use Case:

This API method is used by ISO/ISV, administrators, or developers to subscribe to events related to UW tasks. By setting up a callback URL, you ensure that your system is automatically notified whenever a significant event occurs in the underwriting process, allowing for real-time updates and faster task handling.