Full update a webhook

Replace all fields on an existing webhook subscription.

put/v1/webhooks/{webhookId}

Request

Base URL: https://api.frihet.io
URL: https://api.frihet.io/v1/webhooks/{webhookId}
Auth: API key in header X-API-Key

Path parameters

webhookIdstring required

Webhook unique identifier

Request body

namestring

urlstring uri

secretstring

HMAC secret for verifying webhook signatures. Write-only: never returned by read endpoints (see hasSecret).

eventsstring[]

status'active' | 'inactive' | 'paused'

metadataobject

Response

Webhook updated

Example response

{
  "data": {
    "name": "Invoice notifications",
    "url": "https://example.com/webhooks/frihet",
    "events": [
      "invoice.created",
      "invoice.paid",
      "expense.created"
    ]
  }
}

Changes

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