ConnectCloud Developers

Receive a request to an inbound webhook (public)

POST /api/comms/v1/hooks/{publicId}

Module: Comms · operationId: receiveInboundWebhook · Tag: Inbound webhooks · Auth: none

Needs no session or CSRF token: the endpoint verifies the sender by its scheme (standard_webhooks, hmac_sha256 or token). Only verified requests are stored; a request with a delivery id seen before is stored once and answered with 200. Unknown or disabled endpoints answer 404, failed checks 401 without detail. Limited to 10 requests per second per client with bursts up to 50.

Parameters

Name In Type Required Description
publicId path string yes

Request body

*/* (required)

Responses

  • 200 Already stored (application/json)
  • 202 Stored (application/json)
  • 401 Error (application/json)
  • 404 Error (application/json)
  • 413 Error (application/json)
  • 429 Rate limited

Fields of the 200 answer:

  • duplicate (boolean): The delivery id was seen before; the request was stored once
  • id (string (uuid)): Id of the stored request

Example 200 answer:

{
  "duplicate": false,
  "id": "4c7d1e9a-3b5f-4a2c-9e8d-6f0a1b2c3d4e"
}

Example request

curl -X POST 'https://api.mbcom.cloud/api/comms/v1/hooks/string' \
  -H 'Content-Type: */*' \
  --data-binary @body

View as Markdown · Interactive reference · OpenAPI