Update a webhook

POST/api/v2/webhooks/{webhookId}

Changes the URL of one of your firm’s webhooks. The next event is sent to the new URL. The event a webhook receives cannot be changed: to switch events, delete the webhook and register a new one.

Path parameters

Param	Type	Required	Description
`webhookId`	`number`	Required	The `id` of the webhook, as returned by List webhooks.

Body parameters

Field	Type	Required	Description
`url`	`string`	Required	The new address, starting with `https://` or `http://`.

Request

cURL

POST /api/v2/webhooks/{webhookId}


curl --location 'https://www.reviewsolicitors.co.uk/api/v2/webhooks/{webhookId}' \
     --header 'Authorization: Bearer {access_token}' \
     --header 'Content-Type: application/json' \
     --data   '{
          "url": "https://example.com/reviewsolicitors/v2"
     }'

Response

200 OK


{
  "id": 399,
  "url": "https://example.com/reviewsolicitors/v2",
  "eventType": "NEW_REVIEW",
  "status": "ACTIVE"
}

Returns the updated webhook. See the webhook object.

Errors

Code	Cause
400	`url` is missing or is not a full URL. Returns a list of field errors.
400	Another webhook of your firm already uses this `url` for the same event.
404	No active webhook with that `webhookId` belongs to your firm.