Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Rotate Webhook Endpoint Signing Secret

WebhookEndpointWithSecret webhooks().rotateSecret(params = WebhookRotateSecretParams.none(), requestOptions = RequestOptions.none())
POST
/webhook_endpoints/{webhook_endpoint_id}/rotate_secret

Rotates the signing secret for a webhook endpoint in the authenticated project.

Parameters
WebhookRotateSecretParams params
Optional<String> webhookEndpointId
Optional<Boolean> keepOldSecretActiveFor24Hours

Whether to keep the previous signing secret valid for 24 hours after rotation. Defaults to false, which invalidates the previous secret immediately.

Returns
class WebhookEndpointWithSecret:
String id

The unique ID of the webhook endpoint.

long createdAt

The Unix timestamp when the endpoint was created.

formatunixtime
List<String> eventTypes

The event types that trigger deliveries to this endpoint.

String name

The human-readable name of the endpoint.

JsonValue; object_
constant
constant

The object type, which is always webhook_endpoint.

String signingSecret

The endpoint’s signing secret. This is returned only when the endpoint is created or the secret is rotated.

Optional<String> signingSecretHint

A masked hint for the endpoint’s signing secret.

String url

The HTTPS URL that receives webhook deliveries.

Optional<Long> updatedAt

The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.

formatunixtime

Rotate Webhook Endpoint Signing Secret

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.webhooks.WebhookEndpointWithSecret;
import com.openai.models.webhooks.WebhookRotateSecretParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        WebhookEndpointWithSecret webhookEndpointWithSecret = client.webhooks().rotateSecret("whe_123");
    }
}
200 — Example
{
  "id": "id",
  "created_at": 0,
  "event_types": [
    "string"
  ],
  "name": "name",
  "object": "webhook_endpoint",
  "signing_secret": "signing_secret",
  "signing_secret_hint": "signing_secret_hint",
  "url": "url",
  "updated_at": 0
}
Returns Examples
200 — Example
{
  "id": "id",
  "created_at": 0,
  "event_types": [
    "string"
  ],
  "name": "name",
  "object": "webhook_endpoint",
  "signing_secret": "signing_secret",
  "signing_secret_hint": "signing_secret_hint",
  "url": "url",
  "updated_at": 0
}