Obter endpoint de webhook da organização

$client->beta->organization->webhooks->retrieve(string webhookEndpointID, ?list<AnthropicBeta> betas): OrganizationWebhookEndpoint

GET/v1/organizations/webhooks/{webhook_endpoint_id}

Requires anthropic-beta: webhooks-2026-10-07. How to send beta headers

Recupere um endpoint de webhook da organização pelo ID.

Toda solicitação deve incluir o cabeçalho beta anthropic-beta: webhooks-2026-10-07. Uma solicitação sem ele retorna 404, exatamente como se esta API não existisse. A Anthropic ativa os endpoints de webhook da organização para cada organização; até que a sua esteja ativada, as solicitações também retornam 404. Os endpoints de webhook da organização estão em beta e não estão disponíveis para organizações com prontidão para HIPAA habilitada.

Parameters

webhookEndpointID: string⁠Path

ID of the webhook endpoint.

betas?: optional list<AnthropicBeta>⁠Header

This endpoint is in beta: requests must send webhooks-2026-10-07 in this header.

Returns

class OrganizationWebhookEndpoint { $id; $createdAt; $description; /* 6 more */ }

string id

ID of the webhook endpoint.

\Datetime createdAt

When the endpoint was created, in RFC 3339 format.

string description

Notes about the endpoint. An empty string when none were given.

string disabledReason

Why Anthropic disabled the endpoint automatically. An empty string when the endpoint is enabled, or when you disabled it.

list<EnabledEvent> enabledEvents

The event types delivered to the endpoint.

string name

A short label for the endpoint. An empty string when none was given.

OrganizationWebhookEndpointState state

Whether deliveries are sent to the endpoint.

\Datetime updatedAt

When the endpoint was last changed, in RFC 3339 format.

string url

The HTTPS URL that deliveries are sent to.

Obter endpoint de webhook da organização

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Anthropic\Client;
use Anthropic\Beta\AnthropicBeta;

$client = new Client(apiKey: 'my-anthropic-api-key');

$betaOrganizationWebhookEndpoint = $client
  ->beta
  ->organization
  ->webhooks
  ->retrieve(
  'webhook_endpoint_id', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24]
);

var_dump($betaOrganizationWebhookEndpoint);

Response 200

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "disabled_reason": "disabled_reason",
  "enabled_events": [
    "user_profile.enforcement_action_opened"
  ],
  "name": "name",
  "state": "disabled",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "url": "url"
}

Returns Examples

Response 200

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "disabled_reason": "disabled_reason",
  "enabled_events": [
    "user_profile.enforcement_action_opened"
  ],
  "name": "name",
  "state": "disabled",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "url": "url"
}