Skip to content

Subscribe to webhooks of a session

Request

Registers an HTTPS endpoint to receive CloudEvents-formatted webhook notifications for the given session. Payloads are signed with your organization's static webhook signing secret (Standard Webhooks, HMAC-SHA256, 'webhook-signature' header).

Security
keycloakAuthLive or keycloakAuthTest
Path
sessionIdstring, (uuid)required
Bodyapplication/json
urlnull or string, (uri)required
eventTypesArray of strings or nullrequired
curl -i -X POST \
  'https://doc.mifundo.com/_mock/mca/v1/sessions/{sessionId}/webhook-subscriptions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": null,
    "eventTypes": null
  }'

Responses

Created

Bodyapplication/json
idstring, (uuid)required

Unique identifier of the webhook subscription.

sessionIdstring, (uuid)required

Identifier of the session to which this subscription applies.

urlnull or string, (uri)required

HTTPS endpoint to which webhook events are delivered via POST.

eventTypesArray of strings or nullrequired

Event types delivered to the subscriber (e.g. 'com.mifundo.customer.input-received.v1').

createdAtUtcstring, (date-time)required

Timestamp (UTC) at which the subscription was created.

Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459", "url": null, "eventTypes": null, "createdAtUtc": "2019-08-24T14:15:22Z" }