Webhook

Test delivery to your endpoint

​

Sent synchronously by POST /v1/webhook_endpoints/{id}/test, signed exactly like a real event. Not part of the event catalog and never stored — a contract ping between Roster and your receiver.

Headers
  • Roster-Signature
    Type: string
    required

    t={unix_seconds},v1={hmac_sha256("{t}.{body}", secret)} — reject timestamps older than 300 seconds.

Body
required
application/json
  • event_id
    Type: string
    required
  • event_type
    const:  
    webhook.test
    required
  • occurred_at
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • payload
    Type: object
    required
Responses
  • 200

    Return any 2xx to acknowledge the delivery.

Request Example for postwebhookTest
{
  "event_id": "",
  "event_type": "webhook.test",
  "occurred_at": "",
  "payload": {
    "message": "Roster webhook test delivery"
  }
}
No Body

Return any 2xx to acknowledge the delivery.