Operator Events

Update Operator Event Destination

Changed on

Updates an operator event destination. topics uses full-replacement semantics: the list sent becomes the subscription.

config and credentials take the fields of the destination's type; fields that are not sent keep their value. The type itself cannot be changed.

To change the signing secret of a webhook destination, set credentials.secret, or send credentials.rotate_secret: true to have Outpost generate a new one. On rotation the current secret stays valid as previous_secret, for 24 hours by default.

Returns 404 destination not found if no operator event destination has this ID, or 404 tenant not found if the project has never had one.

This endpoint is only available on managed Outpost.

patch/operator-events/destinations/{destination_id}

Request

  • Base URL
    https://api.outpost.hookdeck.com/2025-07-01
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

topicsstring[]

Replacement list of operator event topics. Use ["*"] to subscribe to every topic. Full-replacement semantics: the list sent becomes the subscription.

configobject

Config fields to change for the destination's type. Merge-patch semantics: fields that are not sent keep their value.

credentialsobject

Credential fields to change for the destination's type. Merge-patch semantics: fields that are not sent keep their value. For webhook, set secret to replace the signing secret, or send rotate_secret: true to have Outpost generate a new one and keep the current one valid as previous_secret.

Example request

{
  "topics": [
    "alert.destination.disabled",
    "alert.attempt.exhausted_retries"
  ],
  "config": {
    "url": "https://alerts.acme.com/outpost"
  },
  "credentials": {
    "rotate_secret": true
  }
}

Response

The updated operator event destination.

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "id": "des_webhook_123",
  "type": "webhook",
  "topics": [
    "user.created",
    "order.shipped"
  ],
  "disabled_at": null,
  "created_at": "2024-02-15T10:00:00Z",
  "updated_at": "2024-02-15T10:00:00Z",
  "config": {
    "url": "https://my-service.com/webhook/handler"
  },
  "credentials": {
    "secret": "whsec_abc123def456",
    "previous_secret": "whsec_prev789xyz012",
    "previous_secret_invalid_at": "2024-02-16T10:00:00Z"
  }
}

Changes