---
title: "Update event stream"
method: PUT
path: "/event-streams/{event_stream_id}"
tags: ["event-streams"]
---

# Update event stream

`PUT /event-streams/{event_stream_id}`

Updates an existing event streaming connection.

## Path parameters

- `event_stream_id` string, uuid, required

## Request body

- UpdateEventStreamInfo — Information needed to update an event stream.
  - `name` string — Updated name for the event stream.
  - `enabled` boolean — Whether the event stream should be enabled.
  - `webhook_url` string — Updated webhook URL.
  - `credentials` WebhookCredentials — Authentication credentials for a webhook connection.
    - `auth_type` 'NONE' | 'API_KEY' | 'HMAC', required — The authentication type for webhook connections.
    - `api_key_credentials` WebhookApiKeyCredential[] — API key credentials, present when auth_type is API_KEY.
      - `id` string, uuid, required — The unique identifier for the credential.
      - `name` string, required — The name of the API key.
      - `value` string, required — The value of the API key.
      - `location` 'HEADER' | 'QUERY_PARAM', required — Where the API key is placed in webhook requests.
    - `hmac_credential_1` WebhookHmacCredential — An HMAC credential for webhook authentication.
      - `id` string, uuid, required — The unique identifier for the credential.
      - `secret` string, required — The HMAC secret value.
      - `created_at` string, date-time, required — When the credential was created.
    - `hmac_credential_2` WebhookHmacCredential — An HMAC credential for webhook authentication.
      - `id` string, uuid, required — The unique identifier for the credential.
      - `secret` string, required — The HMAC secret value.
      - `created_at` string, date-time, required — When the credential was created.

## Response `200`

The updated event stream.

- EventStream — An event streaming connection that publishes events to an external system.
  - `event_stream_id` string, uuid, required — The ID of the event stream.
  - `connection` EventStreamConnection, required — The connection configuration for an event stream.
    - `name` string, required — The name of the connection.
    - `connection_type` 'WEBHOOK', required — The type of event stream connection.
    - `enabled` boolean, required — Whether the connection is enabled.
    - `webhook_url` string — The webhook URL, present when connection_type is WEBHOOK.
    - `credentials` WebhookCredentials — Authentication credentials for a webhook connection.
      - `auth_type` 'NONE' | 'API_KEY' | 'HMAC', required — The authentication type for webhook connections.
      - `api_key_credentials` WebhookApiKeyCredential[] — API key credentials, present when auth_type is API_KEY.
        - `id` string, uuid, required — The unique identifier for the credential.
        - `name` string, required — The name of the API key.
        - `value` string, required — The value of the API key.
        - `location` 'HEADER' | 'QUERY_PARAM', required — Where the API key is placed in webhook requests.
      - `hmac_credential_1` WebhookHmacCredential — An HMAC credential for webhook authentication.
        - `id` string, uuid, required — The unique identifier for the credential.
        - `secret` string, required — The HMAC secret value.
        - `created_at` string, date-time, required — When the credential was created.
      - `hmac_credential_2` WebhookHmacCredential — An HMAC credential for webhook authentication.
        - `id` string, uuid, required — The unique identifier for the credential.
        - `secret` string, required — The HMAC secret value.
        - `created_at` string, date-time, required — When the credential was created.

---

[API](https://skmtc.net/opal/apis/opal-api.md) · [All operations](https://skmtc.net/opal/apis/opal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/opal/opal-api/versions/13b58df96d40/schema)