Create Webhook Subscription

Create a Webhook Subscription.

post/api/v1/webhook_subscriptions

Request

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

Headers

Content-Typestring

Request body

namestring required

The name of the webhook subscription

urlstring required

The URL that will receive POSTed webhook data. HTTPS only.

eventTypesstring[] required

Event types, see ELC Webhooks Intro for a list

Response

200

idstring
eventTypesstring[]
namestring
urlstring

Example response

{
  "id": "019201f3-3639-7fd9-b3e7-f3ea2cfd51c1",
  "eventTypes": [
    "assignmentCompleted"
  ],
  "name": "My Assignment Webhook",
  "url": "https://webhook.example.com/assignment"
}

Changes

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