PATCH - Webhook
This API allows authenticated users to update an existing webhook configuration. Only the endpoint URL and secret hash can be modified - the API template and other core settings remain unchanged.
Key Notes:
- Requires authentication and ownership of the webhook (created by the authenticated user).
- Only
endpoint_urlandsecret_hashfields can be updated. - The API template ID cannot be changed after webhook creation.
- Returns the updated webhook details after successful modification.
Updatable Fields:
- endpoint_url: The URL where webhook notifications will be sent (required)
- secret_hash: Optional secret key for webhook authentication (will be encrypted)
Non-Updatable Fields:
- api_template: Cannot be changed after webhook creation
- status: Managed separately by the system
- created_by: Immutable field
Scenario: Updating Webhook Configuration
- A developer needs to change their webhook endpoint URL due to server migration.
- They call this endpoint with the webhook ID and new endpoint URL.
- They can also update the secret hash if they want to change authentication.
- The system updates the webhook and returns the modified configuration.
- This is useful for maintaining webhook functionality during infrastructure changes.
PATCH
Update Webhook
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the webhook to update.
Body
application/json
Response
Webhook updated successfully.