Webhooks

Update a workspace webhook subscription

Changed on
patch/workspaces/{workspaceId}/webhooks/{id}

Request

  • Base URL
    https://api.releases.sh
  • URL
    https://api.releases.sh/workspaces/{workspaceId}/webhooks/{id}
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required
idstring required

Request body

urlstring
format'json' | 'slack' | 'discord'
descriptionstring nullable
enabledboolean
disabledReasonstring nullable
releaseType'feature' | 'rollup' nullable
sourceIdstring nullable
sourceSlugstring
productIdstring nullable
productSlugstring

Response

The updated subscription

idstring required
scope'org' required
orgIdstring nullable required
urlstring required
sourceIdstring nullable required
productIdstring nullable required
releaseType'feature' | 'rollup' nullable required
format'json' | 'slack' | 'discord' required
enabledboolean required
descriptionstring nullable required
secretVersioninteger required
createdAtstring required
lastSuccessAtstring nullable required
lastErrorAtstring nullable required
lastErrorMsgstring nullable required
consecutiveFailuresinteger required
disabledReasonstring nullable required
failureStreakStartedAtstring nullable required
workspaceIdstring required
deliveryHealth'never_delivered' | 'healthy' | 'degraded' | 'failing' | 'paused' | 'auto_paused' required
deliveryHealthSummarystring required

Changes