DEdefaulr
WebhookSubscriptions

Update a webhook subscription

Changed on

Update an existing webhook subscription. Updating a disabled subscription enables it again. Only workspace administrators can access this endpoint.

post/webhookSubscriptions.update

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/webhookSubscriptions.update
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

idstring uuid required

Unique identifier for the webhook subscription.

namestring required

A descriptive name for the webhook subscription.

urlstring uri required

The URL that receives webhook requests. Cloud-hosted workspaces require an HTTPS URL.

secretstring nullable

An optional secret used to sign webhook requests.

eventsstring[] required

Event names or namespaces that trigger the webhook. Use * to subscribe to all events.

Example request

{
  "name": "Production webhook",
  "url": "https://example.com/webhooks/outline",
  "secret": "ol_whs_1234567890abcdef",
  "events": [
    "documents.create",
    "documents.update"
  ]
}

Response

OK

Example response

{
  "data": {
    "name": "Production webhook",
    "url": "https://example.com/webhooks/outline",
    "secret": "ol_whs_1234567890abcdef",
    "events": [
      "documents.create",
      "documents.update"
    ],
    "createdBy": {
      "name": "Jane Doe"
    }
  }
}

Changes