API Reference

Receive Session Event

wbhk
Session Events

Plugsurfing sends session event notifications to the configured webhook URL. Known event names are SESSION_STARTED, SESSION_STOPPED, SESSION_COMPLETE, SESSION_START_FAILED, SESSION_STOP_FAILED, and SESSION_FEE_INCURRING. New event names may be introduced without prior notice. Events are sent once and the receiver response is not used for retries.

Payload
string
required

Event name. Known values: SESSION_STARTED, SESSION_STOPPED, SESSION_COMPLETE, SESSION_START_FAILED, SESSION_STOP_FAILED, SESSION_FEE_INCURRING. New values may be introduced without prior notice.

payload
required

Session event payload. Exactly one identity variant is present: user session payload or fleet session payload.

Headers
string

Base64 encoded HMAC SHA-512 signature of the raw request body. Present when HMAC signing is configured.

date-time

RFC 3339 timestamp for when the payload was signed. Present when HMAC signing is configured.

Responses
200

Webhook received.

400

Invalid payload.

500

Receiver failed to process the webhook.

Updated about 1 month ago

Payload
Choose an example

Updated about 1 month ago