HOhookdeck
Operator Events

Create Operator Event Destination

Changed on

Creates an operator event destination of any type listed by GET /operator-events/destination-types. config and credentials take the same fields as a tenant destination of that type.

For a webhook destination, set credentials.secret to supply the signing secret. When it is omitted, Outpost generates one. Either way the secret is returned in credentials.

Creating or changing a destination changes which topics the deployment subscribes to, which is why OPERATOR_EVENTS_TOPICS cannot be set through PATCH /config.

This endpoint is only available on managed Outpost.

post/operator-events/destinations

Request

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

Request body

typestring required

Type of the destination. GET /operator-events/destination-types lists the types this deployment accepts and the config and credentials fields each one takes.

topicsstring[] required

Operator event topics to subscribe to. Use ["*"] to subscribe to every topic. See the Operator Events tag description for the available topics.

configobject required

Configuration for the chosen destination type, with the same fields as a tenant destination of that type. Send {} for a type with no config fields.

credentialsobject

Credentials for the chosen destination type, with the same fields as a tenant destination of that type. For webhook this is optional: set secret to supply the signing secret, or omit it and Outpost generates one.

Example request

{
  "type": "webhook",
  "topics": [
    "alert.destination.disabled",
    "alert.destination.consecutive_failure"
  ],
  "config": {
    "url": "https://alerts.acme.com/outpost"
  },
  "credentials": {
    "secret": "whsec_abc123"
  }
}

Response

The created 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