Update Webhook

Description

The Update Webhook endpoint allows you to modify the details of an existing webhook, such as its URL, name, and enabled status. This is useful for maintaining and adjusting your webhook configurations as needed.

Webhooks

Webhooks are best managed in our platform dashboard. You can create, update, and delete webhooks from the dashboard.

HTTP Request

POST /webhooks/update

Authentication

All requests must include an Authorization header with a valid API key.

Headers

Key	Value
Authorization	Bearer YOUR_API_KEY
Content-Type	application/json

Request Body

webhook_id: The ID of the webhook to update.
url: (Optional) The new URL for the webhook.
name: (Optional) The new name for the webhook.
enabled: (Optional) Boolean indicating whether the webhook should be active.

JSON

Field	Type	Description
webhook_id	string	The ID of the webhook to update
url	string	The new endpoint URL for the webhook (optional)
name	string	The new name for the webhook (optional)
enabled	string	Whether the webhook is active (optional)

Request Example

updated_webhook = client.update_webhook(
webhook_id="whk_abc123",                                    # The ID of the webhook to update
url="https://your-domain.com/new-endpoint",                 # The new endpoint URL
name="Updated Webhook Name",                                # The new name for the webhook
enabled="true"                                              # Whether the webhook should be enabled (true/false)
)
# Print the updated webhook details
print(f"Updated Webhook: {updated_webhook}")

Response

Success

Status Code: 200 OK

Body:

{
   "data": {
       "webhook": {
           "id": 7,
           "name": "testing_7",
           "enabled": "false",
           "created_at": "2025-01-09T13:28:27.000000Z",
           "updated_at": "2025-01-24T12:37:02.000000Z"
       }
   }
}

On this page