webhooks

Changed on

Create a webhook subscription

post/v1/webhooks

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/v1/webhooks
  • Auth
    HTTP bearer

Request body

urlstring uri required
event'sdk.build.completed' required
descriptionstring required

Response

Default Response

uidstring required
createdAtinteger required
updatedAtinteger required
event'sdk.build.completed' required
urlstring uri required
enabledboolean required
descriptionstring required
consecutiveFailuresinteger required
disabledReason'consecutive-failures'
disabledAtnumber nullable
secretstring required

Example response

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "createdAt": 1735689600,
  "updatedAt": 1735689600
}

Changes

  • 5e4c47d6805bRevision changes
    • info

      the response's property default value unixTimestamp() was removed for the status

    • info

      the response's property default value unixTimestamp() was removed for the status

  • 002d44a0c0e6Revision changes
    • info

      endpoint added