Create action destination

POST

actions

destinations

import olira
from olira import ActionTrigger, WebhookDestinationConfig

olira.init(api_key="YOUR_API_KEY")
destination = olira.create_action_destination(
    config=WebhookDestinationConfig(url="https://hooks.example.com/olira"),
    subscribed_triggers=[ActionTrigger.PATIENT_STATE_CHANGED, ActionTrigger.INGESTION_FAILED],
)
print(destination.signing_secret)  # shown once, store it now

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");

var destination = OliraModule.CreateActionDestination(
    webhookConfig: new WebhookDestinationConfig { Url = "https://hooks.example.com/olira" },
    subscribedTriggers: [ActionTrigger.PatientStateChanged, ActionTrigger.IngestionFailed]);
Console.WriteLine(destination.SigningSecret); // shown once, store it now

POST /v1/actions/destinations
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "config": {"destination_type": "webhook", "url": "https://hooks.example.com/olira"},
  "subscribed_event_types": ["patient.state.changed", "ingestion.failed"]
}

ActionDestination(
    id="68582e4a0a0b3c1234567890",
    project_id=None,
    destination_type="webhook",
    status="active",
    description=None,
    subscribed_triggers=["patient.state.changed", "ingestion.failed"],
    config={"destination_type": "webhook", "url": "https://hooks.example.com/olira", "api_version": "2026-08-01"},
    signing_secret_last4="wxlA",
    rate_limit_per_minute=600,
    digest_schedule=None,
    consecutive_failures=0,
    auto_disabled_at=None,
    rotated_at=None,
    signing_secret="whsec_C-8mLEFGnat57TspFl581aGumYpI2dNzKxdi-9Iu1UI",
)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Destination not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Destination not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "value_error",
      "message": "Request validation failed"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

olira.create_action_destination(
    config: WebhookDestinationConfig | EmailDestinationConfig | dict,
    subscribed_triggers: list[ActionTrigger | str] | None = None,
    description: str | None = None,
    static_headers: dict[str, str] | None = None,
    rate_limit_per_minute: int | None = 600,
    digest_schedule: DigestSchedule | None = None,
) -> ActionDestination

OliraModule.CreateActionDestination(
    WebhookDestinationConfig? webhookConfig = null,
    EmailDestinationConfig? emailConfig = null,
    IReadOnlyList<string>? subscribedTriggers = null,
    string? description = null,
    IReadOnlyDictionary<string, string>? staticHeaders = null,
    int? rateLimitPerMinute = null,
    DigestSchedule? digestSchedule = null,
)  // -> ActionDestination

Requires scope: sdk:actions The signing secret is returned in plaintext exactly once — store it immediately, it can only be rotated afterward, never re-read.

Parameters

WebhookDestinationConfig | EmailDestinationConfig | dict

required

Destination type and its config: WebhookDestinationConfig (url, optional api_version) or EmailDestinationConfig (to_email, optional subject/from_name). A raw dict is accepted for destination types not yet modeled by this SDK version.

list[ActionTrigger | str] | None

Triggers this destination receives. [”*”] subscribes to every currently available trigger, and, because it is evaluated by the platform rather than by this list, could start receiving additional trigger types later without another call on your part.

str | None

Free-text label shown in the Olira Console.

dict[str, str] | None

Extra headers replayed on every request, e.g. an API key your endpoint expects. Write-only — never read back.

int | None

default:"600"

Per-destination delivery cap, 1–6000.

DigestSchedule | None

Opt in to daily batching for high-frequency triggers instead of one delivery per event.

Returns

ActionDestination — Created destination, including the one-time signing_secret.

str

Olira-assigned destination id.

str | None

Project this destination watches. None = the org’s default project.

str

“webhook” or “email”.

str

“active”, “disabled”, or “auto_disabled”.

str | None

Free-text description.

list[str]

Triggers this destination receives.

dict

Type-specific config as returned by the server (url, api_version, etc).

str | None

Last 4 characters of the current signing secret.

int | None

Per-destination delivery rate cap.

DigestSchedule | None

Digest batching config, if enabled.

int

Running failure streak; resets to 0 on any successful delivery.

str | None

When the destination was auto-disabled (20+ consecutive failures over 72h+), if applicable.

str | None

When the signing secret was last rotated.

str | None

Plaintext signing secret — present only here and on rotate_action_destination_secret responses.

Raises

Exception	When
`AuthError`	HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.
`ValidationError`	HTTP 400, 404, or 422 — malformed JSON or validation failure (message includes response excerpt).
`ServerError`	HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable.
`RateLimitError`	HTTP 429 — rate limited; check retry_after (seconds).
`NetworkError`	Connection timeout, DNS failure, or read error after retries.

import olira
from olira import ActionTrigger, WebhookDestinationConfig

olira.init(api_key="YOUR_API_KEY")
destination = olira.create_action_destination(
    config=WebhookDestinationConfig(url="https://hooks.example.com/olira"),
    subscribed_triggers=[ActionTrigger.PATIENT_STATE_CHANGED, ActionTrigger.INGESTION_FAILED],
)
print(destination.signing_secret)  # shown once, store it now

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");

var destination = OliraModule.CreateActionDestination(
    webhookConfig: new WebhookDestinationConfig { Url = "https://hooks.example.com/olira" },
    subscribedTriggers: [ActionTrigger.PatientStateChanged, ActionTrigger.IngestionFailed]);
Console.WriteLine(destination.SigningSecret); // shown once, store it now

POST /v1/actions/destinations
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "config": {"destination_type": "webhook", "url": "https://hooks.example.com/olira"},
  "subscribed_event_types": ["patient.state.changed", "ingestion.failed"]
}

ActionDestination(
    id="68582e4a0a0b3c1234567890",
    project_id=None,
    destination_type="webhook",
    status="active",
    description=None,
    subscribed_triggers=["patient.state.changed", "ingestion.failed"],
    config={"destination_type": "webhook", "url": "https://hooks.example.com/olira", "api_version": "2026-08-01"},
    signing_secret_last4="wxlA",
    rate_limit_per_minute=600,
    digest_schedule=None,
    consecutive_failures=0,
    auto_disabled_at=None,
    rotated_at=None,
    signing_secret="whsec_C-8mLEFGnat57TspFl581aGumYpI2dNzKxdi-9Iu1UI",
)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Destination not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Destination not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "value_error",
      "message": "Request validation failed"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

import olira
from olira import ActionTrigger, WebhookDestinationConfig

olira.init(api_key="YOUR_API_KEY")
destination = olira.create_action_destination(
    config=WebhookDestinationConfig(url="https://hooks.example.com/olira"),
    subscribed_triggers=[ActionTrigger.PATIENT_STATE_CHANGED, ActionTrigger.INGESTION_FAILED],
)
print(destination.signing_secret)  # shown once, store it now

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");

var destination = OliraModule.CreateActionDestination(
    webhookConfig: new WebhookDestinationConfig { Url = "https://hooks.example.com/olira" },
    subscribedTriggers: [ActionTrigger.PatientStateChanged, ActionTrigger.IngestionFailed]);
Console.WriteLine(destination.SigningSecret); // shown once, store it now

POST /v1/actions/destinations
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "config": {"destination_type": "webhook", "url": "https://hooks.example.com/olira"},
  "subscribed_event_types": ["patient.state.changed", "ingestion.failed"]
}

ActionDestination(
    id="68582e4a0a0b3c1234567890",
    project_id=None,
    destination_type="webhook",
    status="active",
    description=None,
    subscribed_triggers=["patient.state.changed", "ingestion.failed"],
    config={"destination_type": "webhook", "url": "https://hooks.example.com/olira", "api_version": "2026-08-01"},
    signing_secret_last4="wxlA",
    rate_limit_per_minute=600,
    digest_schedule=None,
    consecutive_failures=0,
    auto_disabled_at=None,
    rotated_at=None,
    signing_secret="whsec_C-8mLEFGnat57TspFl581aGumYpI2dNzKxdi-9Iu1UI",
)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Destination not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Destination not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "value_error",
      "message": "Request validation failed"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

​Parameters

​Returns

​Raises

Parameters

Returns

Raises