Documentation Powered by ReDoc

SmarterWX Sentinel Referral Webhook Event API (0.1.1)

Download OpenAPI specification:Download

Schema definition for SmarterWX Sentinel Referral Webhook notifications

The subscriber provides a secret key that is used to generate a signature passed in the header of each notification. The receiver can verify that the notification was signed using the provided secret by verifying the X-SWX-Signature header.

The receiver must respond with a 2XX status code within 3 seconds of receiving the notification. If the notification was not succesfully acknowledged, it will be sent again until a successful response is received or the notification times out. The uuid can be used for deduplication purposes.

Endpoint to receive Web Hook notification for refe

Endpoint to receive Web Hook notification for referral

header Parameters
X-SWX-Signature
required
string
Example: sha256=abc123def456ghi789jkl
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array ()
uuid
required
string <uuid>

Unique identifier for this event

event
required
string
Enum: "referral:create" "referral:update"

The webhook event trigger

timestamp
required
string <date-time>

The timestamp of the original event

required
object (Referral)

Responses

Request samples

Content type
application/json
[
  • {
    }
]