Skip to main content
PUT
/
webhooks
/
{webhookId}
Obter webhook
curl --request PUT \
  --url https://api.example.com/webhooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "subscriptions": [
    "messages.upsert"
  ]
}
'

Authorizations

​
X-Api-Key
string
header
required

Chave privada da API

Path Parameters

​
webhookId
string
required

Body

application/json
​
name
string
required

Nome do webhook para identificação amigável.

​
url
string
required

URL que receberá as requisições do webhook.

​
subscriptions
enum<string>[]
required

Eventos que o webhook irá receber.

Available options:
messages.upsert,
connection.update,
blocklist.set,
blocklist.update,
call,
chats.upsert,
chats.update,
chats.delete,
contacts.upsert,
contacts.update,
creds.update,
groups.upsert,
groups.update,
group-participants.update,
group.join-request,
labels.edit,
labels.association,
lid-mapping.update,
messages.delete,
messages.update,
messages.media-update,
messages.reaction,
message-receipt.update,
messaging-history.set,
newsletter.reaction,
newsletter.view,
newsletter-participants.update,
newsletter-settings.update,
presence.update

Response

200

Default Response