Skip to main content
Use this endpoint to subscribe a destination URL to BugSmash workspace events. The response includes a secret_key used to verify the authenticity of incoming webhook payloads.
The secret_key is returned only once at creation time. Store it securely — if lost, you must delete and recreate the webhook to obtain a new one.

Endpoint

Request

Headers

string
required
Your Bugsmash API key.
string
required
Must be application/json.

Body parameters

string[]
required
Events to subscribe to. Allowed values: new_comment, comment_replied, status_changed, comment_updated.
string
required
Destination URL that will receive event payloads.

Example request

Response

Response fields

boolean
true when the webhook was created successfully.
string
Human-readable status message.
object
The newly created webhook record.
string
Signing secret used to verify webhook payloads. Shown only once — it cannot be retrieved later.
string
Friendly reminder about storing the secret key.
object
Information about the signing algorithm and required headers.
Once you have your secret key, see Verify Webhook Signatures for an example of how to validate incoming payloads.