Update Webhook

Updates an existing webhook configuration. This endpoint allows you to modify the name, URL, subscribed events, or status of an existing webhook using a partial update (PATCH).

HTTP Method and URL

PATCH {{host}}/api/v2/webhooks/:uuid

Authentication Requirements

Requires a valid user-token (Bearer token) in the request headers.

Path Parameters

Request Body

Content-Type: application/json or multipart/form-data

Note: Only include the fields you want to update. Omitted fields will remain unchanged.

Example Request

PATCH {{host}}/api/v2/webhooks/abc123-def456-ghi789
Authorization: Bearer {USER-TOKEN}
Content-Type: application/json
{
  "name": "Updated Webhook Name",
  "events": ["project.completed", "project.signed"]
}

Example Successful Response

{
  "success": true,
  "message": "Webhook updated successfully.",
  "data": {
    "uuid": "abc123-def456-ghi789",
    "name": "Updated Webhook Name",
    "url": "https://example.com/webhook",
    "events": ["project.completed", "project.signed"],
    "status": "active",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-25T16:00:00Z"
  }
}

Error Responses

• 400 Bad Request: Invalid field values in the request body.

• 401 Unauthorized: Missing or invalid authentication token.

• 404 Not Found: Webhook with the specified UUID does not exist.

• 422 Unprocessable Entity: The updated webhook URL is invalid or unreachable.

• 500 Internal Server Error: Unexpected server error.

Usage Notes

• The user-token variable should be set in your environment or as a global variable.

• The webhook-uuid variable should contain the UUID of the webhook you want to update.

• Use the "Get All Webhooks" or "Get Specific Webhook" endpoint first to obtain the current configuration.

• To deactivate a webhook without deleting it, set the status field to inactive.