Logo
Try our API
PUT/webhooks

Update Webhook

Update webhook configuration

Implementation Notes

This endpoint updates the configuration of an existing webhook.

Parameters:

  • endpoint: The new target URL to send webhook payloads to.
  • authType: Authentication method (none, basic, querystring, authheader, header, bearer).
  • userName: Required for basic authType.
  • password: Required for basic authType.
  • token: Required for token-based authTypes.

Validation Rules:

  • If authType is none, then userName, password, and token must not be present.
  • If authType is basic, both userName and password are mandatory.
  • If authType is querystring or authheader or header or bearer token must be provided.
  • You must provide either user credentials or a token, but not both.

Example Request:



{
"endpoint": "https://example.com/updated-hook",
"authType": "querystring",
"token": "********"
}

PUT/webhooks

Parameter Details

NameInTypeRequiredDescription
bodybodyobjectRequirednone
» isAlertHookbodybooleanOptionalIndicates if this webhook is used for alerts.
» endpointbodyRequiredUpdated webhook endpoint URL
» authTypebodystringRequiredUpdated authentication type
» userNamebodystringOptionalRequired if authType is basic
» passwordbodystringOptionalRequired if authType is basic
» tokenbodystringOptionalRequired if using token-based authType (querystring, authheader, header, bearer).

Responses

StatusMeaningDescriptionSchema
200OKWebhook updated successfully
400Bad RequestInvalid input – Validation error or Webhook not foundNone

Example Request

# You can also use wget
curl -X PUT /webhooks \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response
{
"endpoint": "https://example.com/updated-hook",
"authType": "querystring",
"token": "********"
}

Body parameter

{
  "isAlertHook": true,
  "endpoint": "https://example.com/updated-hook",
  "authType": "none",
  "userName": "admin",
  "password": "newpassword123",
  "token": "********"
}

Example responses

200 Response
{
  "message": "Webhook updated successfully"
}
PreviousGet Webhook
NextSubmit Rate Highway Request

Need Support?

Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.

Contact Support