API · webhooks

Create webhook

POST /api/v2/webhooks

Authorization

Owner/admin user session (use inboxit login). Use the CLI login flow; a workspace API key cannot call this operation.

Parameters

All resource access is checked against the selected workspace and user permissions.

Name	Type	Contract
url	string · required	Public HTTPS port 443; no private destinations/redirects
events	string[] · required	Nonempty subset: email.delivered, email.bounced, email.received

Request

Run inboxit login first. The CLI supplies authenticated user credentials.

Example

inboxit webhooks create --data @request.json

JSON body

Save this JSON as request.json for the request above. Replace example values with your own.

Example

{
  "url": "https://yourbrand.com/hooks/inboxit",
  "events": [
    "email.delivered",
    "email.bounced",
    "email.received"
  ]
}

Response

HTTP 201. Example values are illustrative; excerpts are marked.

Example

{
  "id": "ENDPOINT_UUID",
  "secret": "ONE_TIME_SIGNING_SECRET"
}

Behavior & errors

Five active endpoints per workspace. Store the secret immediately. See the webhook guide for raw-body signature verification and retries. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.