Skip to main content
POST
/
comms
/
v1
/
api
/
comms
/
webhook
Set the comms-sent webhook URL for this client.
curl --request POST \
  --url https://api.qflowhub.io/comms/v1/api/comms/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '
{
  "url": "<string>"
}
'
{
  "url": "<string>",
  "secret": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.qflowhub.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 access token issued by https://identity.qflowhub.io/core. Include as Authorization: Bearer <token>. See the Authentication guide for the token flow.

​
Ocp-Apim-Subscription-Key
string
header
required

Your APIM subscription key. Sent in the welcome email when your account is enabled. Required on every request alongside the bearer token.

Body

Request body for POST /api/comms/webhook.

​
url
string
required

The HTTPS URL we'll POST signed webhooks to. Required.

Response

OK

Response from POST /api/comms/webhook and POST /api/comms/webhook/rotate. The Secret is shown ONCE — store it on your end immediately, we cannot recover it.

​
url
string
​
secret
string

The plaintext signing secret. Shown exactly once at creation/rotation; the server stores it AES-encrypted and we have no way to recover the plaintext after this response. If you lose it, rotate.