Webhooks

Criar endpoint de webhook da organização

POST/v1/organizations/webhooks

Crie um endpoint de webhook da organização.

Listar endpoints de webhook da organização

GET/v1/organizations/webhooks

Liste os endpoints de webhook da organização.

Obter endpoint de webhook da organização

GET/v1/organizations/webhooks/{webhook_endpoint_id}

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

Atualizar endpoint de webhook da organização

POST/v1/organizations/webhooks/{webhook_endpoint_id}

Atualize um endpoint de webhook da organização. Somente os campos que você enviar são alterados.

Excluir endpoint de webhook da organização

DELETE/v1/organizations/webhooks/{webhook_endpoint_id}

Exclua um endpoint de webhook da organização.

Regenerar segredo de assinatura do endpoint de webhook da organização

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

Substitua o segredo de assinatura de um endpoint de webhook da organização. O segredo antigo deixa de funcionar imediatamente. O novo segredo é retornado somente nesta resposta.

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"