PATCH
/
webhooks
/
{webhook_id}
curl --request PATCH \
  --url https://api.zapsterapi.com/v1/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": true,
  "name": "Meu Webhook",
  "url": "https://webhook.example.com/receive"
}'
{
  "created_at": "2025-03-12T23:12:19.448Z",
  "enabled": true,
  "id": "3nsnz68l0xbf0m3uu9tfo",
  "name": "Meu Webhook",
  "test_url": null,
  "url": "https://webhook.mydomain.com"
}

Utilize este endpoint quando precisar atualizar dados do webhook.

Atenção: Toda e qualquer modificação utilizando este endpoint afetará todas as instâncias conectadas a este webhook.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
webhook_id
string
required

Identificador único do webhook.

Body

application/json
​
enabled
boolean

Define se o webhook está ativado.

Example:

true

​
name
string

Nome do webhook configurado.

Example:

"Meu Webhook"

​
url
string

URL para onde os eventos do webhook serão enviados. Obrigatório caso webhook_id não seja fornecido.

Example:

"https://webhook.example.com/receive"

Response

201 - application/json
Webhook registrado com sucesso.

Resposta ao registrar um webhook.

​
created_at
string

Data e hora de criação do webhook.

Example:

"2025-03-12T23:12:19.448Z"

​
enabled
boolean

Indica se o webhook está ativado.

Example:

true

​
id
string

Identificador único do webhook.

Example:

"3nsnz68l0xbf0m3uu9tfo"

​
name
string

Nome do webhook configurado.

Example:

"Meu Webhook"

​
test_url
string | null
deprecated

URL de teste do webhook, se configurada. Caso contrário, será null.

⚠️ Por enquanto esta propriedade sempre será null pois o controle de webhook de teste é feito através do endpoint direcionado para webhooks da instância.

Example:

null

​
url
string

URL para onde os eventos do webhook serão enviados.

Example:

"https://webhook.mydomain.com"

Listar WebhooksExcluir Webhook