WOworkramp

Create Webhook Subscription

post/api/v1/academies/{academy_id}/webhook_subscriptions

Request

  • Base URL
    https://app.workramp.com
  • URL
    https://app.workramp.com/api/v1/academies/{academy_id}/webhook_subscriptions
  • Auth
    API key in header Authorization

Path parameters

academy_idstring required

The id of the Academy

Headers

Authorizationstring
Content-Typestring

Request body

webhookNamestring required

Descriptive name

urlstring required

HTTPS endpoint

eventTypesstring[] required

Valid event types

Response

200

webhookIDstring
webhookNamestring
urlstring
eventTypesstring[]

Example response

{
  "webhookID": "id-string-here",
  "webhookName": "Fancy Webhook",
  "url": "https://example.com/workramp-webhook-endpoint",
  "eventTypes": [
    "userRegistration"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.