Notifications

Rename, change the URL/events, or enable/disable

patch/notifications/webhooks/{webhookId}

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/notifications/webhooks/{webhookId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

webhookIdstring uuid required

Request body

namestring
urlstring
eventTypesstring[]
auditStreamboolean
enabledboolean

Response

Updated

idstring uuid required
projectIdstring uuid nullable required

null: team-wide (every project's events plus team-wide events)

namestring required
kind'generic' | 'slack' | 'discord' required
urlstring required
eventTypesstring[] required

empty: every event type

auditStreamboolean required

also receives every team audit-log entry (event type audit_log; team-wide webhooks only)

enabledboolean required
consecutiveFailuresinteger required
disabledAtstring nullable required

ISO-8601 timestamp

lastSuccessAtstring nullable required

ISO-8601 timestamp

lastFailureAtstring nullable required

ISO-8601 timestamp

lastErrorstring nullable required
createdAtstring required

ISO-8601 timestamp

updatedAtstring required

ISO-8601 timestamp

Changes

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