Webhooks

Organisations-Webhook-Endpunkt erstellen

POST/v1/organizations/webhooks

Erstellt einen Organisations-Webhook-Endpunkt.

Organisations-Webhook-Endpunkte auflisten

GET/v1/organizations/webhooks

Listet die Webhook-Endpunkte der Organisation auf.

Organisations-Webhook-Endpunkt abrufen

GET/v1/organizations/webhooks/{webhook_endpoint_id}

Ruft einen Organisations-Webhook-Endpunkt anhand seiner ID ab.

Organisations-Webhook-Endpunkt aktualisieren

POST/v1/organizations/webhooks/{webhook_endpoint_id}

Aktualisiert einen Organisations-Webhook-Endpunkt. Nur die Felder, die du sendest, werden geändert.

Organisations-Webhook-Endpunkt löschen

DELETE/v1/organizations/webhooks/{webhook_endpoint_id}

Löscht einen Organisations-Webhook-Endpunkt.

Signatur-Secret eines Organisations-Webhook-Endpunkts neu generieren

POST/v1/organizations/webhooks/{webhook_endpoint_id}/regenerate_signing_secret

Ersetzt das Signatur-Secret eines Organisations-Webhook-Endpunkts. Das alte Secret funktioniert ab sofort nicht mehr. Das neue Secret wird nur in dieser Antwort zurückgegeben.

Models

BetaDeletedOrganizationWebhookEndpoint object{ type: "webhook_endpoint_deleted", id }

A deleted organization webhook endpoint.

type: "webhook_endpoint_deleted"

Always webhook_endpoint_deleted.

defaultwebhook_endpoint_deleted

id: string

ID of the deleted webhook endpoint.

BetaNewOrganizationWebhookEndpoint object{ id, created_at, description, 7 more }

A new organization webhook endpoint, with its signing secret.

BetaOrganizationWebhookEndpoint object{ id, created_at, description, 6 more }

A webhook endpoint that belongs to the organization rather than to one of its workspaces.

BetaOrganizationWebhookEndpointSigningSecret object{ signing_secret }

An organization webhook endpoint's new signing secret.

signing_secret: string

The new signing secret. Deliveries are signed with it from now on, and no other response returns it.

BetaOrganizationWebhookEndpointState = "disabled" or "enabled"

Whether deliveries are sent to an organization webhook endpoint.

One of the following:

"disabled"

"enabled"