Unsubscribe from UW Task events

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Unsubscribe from UW Task Events

Deactivates the previously registered webhook subscription for underwriting task events. After this call, the callback URL that was registered via POST /api/v1/uwTasks/subscribe will no longer receive event notifications. This action applies to all merchants under the authenticated account. The request body is empty — simply POSTing to this endpoint with valid credentials is sufficient.

Endpoint

POST /api/v1/uwTasks/unsubscribe

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint when you want to stop receiving webhook notifications for UW task events — for example, when decommissioning a webhook endpoint, switching to a new callback URL (unsubscribe first, then subscribe with the new URL), or when an integration is being shut down. This is also the correct cleanup call if your system starts receiving unexpected or duplicate webhook payloads.

Request Body

No request body fields are required. Send an empty JSON object or an empty body.

{}

Response

200 OK

FieldTypeDescription
statusstring (enum)HTTP status name, e.g., "OK"
errorstringError message if the unsubscription failed
warningstringNon-fatal warning message
validationResultsarrayField-level validation errors, if any
requestIdintegerUnique identifier for this API request
{
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 88960
}

Error Codes

CodeWhen it happens
401Invalid or missing Basic Auth credentials
403User does not have permission for this operation
404No active subscription found for the authenticated account
500Internal server error

Common Mistakes

  • Calling this endpoint when no subscription exists — check for a 404 response and handle it gracefully in your integration.
  • Not re-subscribing with a new callback URL after unsubscribing — if the intent is to change the URL, you must call POST /api/v1/uwTasks/subscribe again with the new URL immediately after unsubscribing.
  • Assuming this endpoint accepts merchant-specific parameters — the unsubscription removes the webhook for the entire authenticated account, not a single merchant.

Related Endpoints

  • POST /api/v1/uwTasks/subscribe — register a new webhook callback URL for UW task events
  • GET /api/v1/uwTasks/getByMerchantId — use polling as an alternative to webhook subscriptions

Example

curl -X POST https://hq.staging.netevia.dev/api/v1/uwTasks/unsubscribe \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json" \
  -d '{}'
Body Params
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
status