PUT
/
session
/
{sessionId}
/
webhook
/
{webhookId}
Update webhook
curl --request PUT \
  --url https://api.zappaz.io/api/v1/session/{sessionId}/webhook/{webhookId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "displayName": "<string>",
  "enabled": true,
  "events": {
    "call": false,
    "blocklist.set": false,
    "blocklist.update": false,
    "chats.delete": false,
    "chats.phoneNumberShare": false,
    "chats.update": false,
    "chats.upsert": false,
    "connection.update": false,
    "contacts.update": false,
    "contacts.upsert": false,
    "creds.update": false,
    "group-participants.update": false,
    "group.join-request": false,
    "groups.update": false,
    "groups.upsert": false,
    "labels.association": false,
    "labels.edit": false,
    "message-receipt.update": false,
    "messages.delete": false,
    "messages.media-update": false,
    "messages.reaction": false,
    "messages.send": false,
    "messages.update": false,
    "messaging-history.set": false,
    "presence.update": false,
    "inbound-message.upsert": false,
    "outbound-message.upsert": false
  },
  "headers": {}
}'
{
  "status": "success",
  "data": {
    "id": "<string>",
    "url": "<string>",
    "displayName": "<string>",
    "enabled": true,
    "events": {
      "call": false,
      "blocklist.set": false,
      "blocklist.update": false,
      "chats.delete": false,
      "chats.phoneNumberShare": false,
      "chats.update": false,
      "chats.upsert": false,
      "connection.update": false,
      "contacts.update": false,
      "contacts.upsert": false,
      "creds.update": false,
      "group-participants.update": false,
      "group.join-request": false,
      "groups.update": false,
      "groups.upsert": false,
      "labels.association": false,
      "labels.edit": false,
      "message-receipt.update": false,
      "messages.delete": false,
      "messages.media-update": false,
      "messages.reaction": false,
      "messages.send": false,
      "messages.update": false,
      "messaging-history.set": false,
      "presence.update": false,
      "inbound-message.upsert": false,
      "outbound-message.upsert": false
    },
    "headers": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "waSessionId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Token de usuário ou sessão, passado diretamente como uma string no cabeçalho 'Authorization'. O token de usuário tem escopo sobre todas as sessões pertencentes ao usuário. O token de sessão é limitado à própria sessão.

Path Parameters

sessionId
string
required

Identificador único da sessão

webhookId
string
required

Identificador único do webhook

Body

application/json
url
string

URL where webhook events will be sent

displayName
string

Optional display name for the webhook

enabled
boolean

Whether the webhook is active

events
object

Configuration of which events this webhook subscribes to

headers
object

Custom headers to be sent with webhook requests

Response

Webhook updated successfully

status
enum<string>
Available options:
success,
error
data
object