Skip to main content
PUT
/
organizations
/
{organizationId}
/
webhooks
/
{id}
Update webhook
curl --request PUT \
  --url http://sandbox.mintlify.com/organizations/{organizationId}/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhooks",
  "events": [
    "organization.created",
    "organization.updated"
  ],
  "isActive": true
}
'
Updates webhook configuration. Allows updating URL, events, and active status.

​
Authentication

This endpoint requires authentication via Bearer token:
  • Authorization: Bearer <token>

​
Path Parameters

ParameterTypeRequiredDescription
organizationIdstring (UUID)YesOrganization ID
idstring (UUID)YesWebhook ID

​
Request Body

FieldTypeRequiredDescription
urlstringNoWebhook endpoint URL
eventsarrayNoArray of event types
isActivebooleanNoEnable/disable webhook

​
Updatable Fields

  • URL: Change webhook endpoint
  • Events: Update subscribed events
  • Active Status: Enable or disable webhook delivery

​
Permissions

Only OWNERS and ADMINS can update webhooks.

​
Example Request

curl -X PUT http://localhost:3001/api/organizations/550e8400-e29b-41d4-a716-446655440000/webhooks/123e4567-e89b-12d3-a456-426614174000 \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/new-webhook",
    "events": ["organization.updated", "member.removed"],
    "isActive": true
  }'

​
Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000",
  "url": "https://example.com/new-webhook",
  "events": ["organization.updated", "member.removed"],
  "isActive": true,
  "createdAt": "2025-01-26T10:00:00Z",
  "updatedAt": "2025-12-26T15:30:00Z"
}

​
Common Errors

​
400 Bad Request

Invalid input data. 
{
  "statusCode": 400,
  "message": ["url must be a valid URL", "events must be an array"]
}

​
401 Unauthorized

Authentication required. 
{
  "statusCode": 401,
  "message": "Authentication required. Provide a valid bearer token."
}

​
403 Forbidden

Only owners and admins can update webhooks. 
{
  "statusCode": 403,
  "message": "Access denied. Only owners and admins can update webhooks."
}

​
404 Not Found

Webhook not found. 
{
  "statusCode": 404,
  "message": "Webhook not found with the provided ID."
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string
required
​
id
string
required

Body

application/json
​
url
string

Webhook endpoint URL

Example:

"https://example.com/webhooks"

​
events
array[]

Events to subscribe to

Example:
[
  "organization.created",
  "organization.updated"
]
​
isActive
boolean

Whether the webhook is active

Example:

true

Response

Webhook updated successfully with new configuration.