GET - Webhook
This API allows authenticated users to retrieve a specific webhook by its unique identifier. Only webhooks created by the authenticated user can be accessed, ensuring proper data isolation and security.
Key Notes:
- Requires authentication and ownership verification (webhook must be created by the authenticated user).
- Returns complete webhook details including configuration and metadata.
- The webhook ID must be a valid UUID format.
- Returns 404 if webhook doesn’t exist or user doesn’t have access to it.
Path Parameters:
- id (required): Unique identifier of the webhook (UUID format)
Scenario: Retrieving Webhook Details
- A developer wants to check the configuration of a specific webhook they created.
- They call this endpoint with the webhook’s UUID.
- The system verifies ownership and returns the webhook details.
- This is useful for debugging webhook issues or verifying configuration before updates.
GET
Get Webhook by ID
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the webhook.
Response
Webhook retrieved successfully.
Previous
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_url` and `secret_hash` fields 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.
Next
Get Webhook by ID