Skip to main content
PATCH
Atualiza URL, eventos assinados ou status

Authorizations

Authorization
string
header
required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

endpointId
string
required
Pattern: ^whep_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
url
string<uri>

Nova URL HTTPS de destino das entregas de webhook (POST assinado por HMAC).

Example:

"https://exemplo.com/webhooks/repass"

description
string | null

Descrição livre do endpoint, para você identificá-lo. null limpa a descrição.

Maximum string length: 500
Example:

"Webhook de produção do CRM"

subscribedEvents
string[]

Nova lista de tipos de evento que o endpoint deve receber, como affiliate.approved ou conversion.created (pelo menos um).

Minimum array length: 1
Example:
status
enum<string>

Novo status do endpoint. active reativa o endpoint; disabled o pausa manualmente.

Available options:
active,
disabled
Example:

"active"

Response

200 - application/json

Default Response

id
string
required

Identificador único do endpoint de webhook (prefixo whep_ + ULID).

Example:

"whep_01J9Z3K8N2QF4T7B9XP0WMD5RC"

organizationId
string
required

Organização (tenant) dona do endpoint.

Example:

"org_01J9Z3K8N2QF4T7B9XP0WMD5RC"

url
string
required

URL HTTPS de destino das entregas de webhook.

Example:

"https://exemplo.com/webhooks/repass"

description
string | null
required

Descrição livre do endpoint. null quando não informada.

Example:

"Webhook de produção do CRM"

subscribedEvents
string[]
required

Tipos de evento que o endpoint recebe.

Example:
status
enum<string>
required

Status atual do endpoint.

Available options:
active,
disabled
Example:

"active"

disabledReason
enum<string> | null
required

Motivo do endpoint estar desabilitado. failure_rate: desativado automaticamente por alta taxa de falhas. manual: desativado manualmente. null quando o endpoint está ativo.

Available options:
failure_rate,
manual
Example:

"failure_rate"

maskedSecret
string
required

Segredo de assinatura HMAC mascarado. O valor em claro só é retornado na criação do endpoint e ao rotacionar o segredo.

Example:

"whsec_••••••••••5RC"

previousSecretExpiresAt
string<date-time> | null
required

Expiração do segredo anterior durante a janela de carência de 24h após uma rotação (ISO-8601). null quando não há rotação em curso.

Example:

"2026-06-14T12:00:00.000Z"

createdAt
string<date-time>
required

Data de criação do endpoint (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"

updatedAt
string<date-time>
required

Data da última atualização do endpoint (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"