Skip to content
EntitlerDocs

PUT/v1/webhook-endpoint

Set the webhook endpoint

Sets the environment's HTTPS endpoint url and noticeDays (0 to 30, 0 sends no renewal notice). The signing secret appears only when the endpoint is created or rotateSecret is set. Needs project:settings.

curl -X PUT 'https://api.entitler.co/v1/webhook-endpoint' \
  -H "Authorization: Bearer $ENTITLER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"noticeDays":1,"rotateSecret":true,"target":{"environmentId":"environmentId","projectId":"projectId","teamId":"teamId"},"url":"url"}'

Credentials

Send any one of these:

  • Bearer token

Request body

object

  • noticeDaysinteger (int64)

    at least 0; at most 4294967295

  • rotateSecretboolean
  • targetProductTarget
    • environmentIdstring
    • projectIdstring
    • teamIdstring
  • urlstring

Responses

200The SetWebhookEndpointResponse message.

SetWebhookEndpointResponse

  • endpointWebhookEndpoint
    • noticeDaysinteger (int64)required

      at least 0; at most 4294967295

    • updatedAtintegerrequired

      at least 0; at most 18446744073709552000

    • urlstringrequired
  • signingSecretstring

ErrorA refusal, with the HTTP status of its gRPC code.

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired