Passer au contenu principal
PUT
/
api
/
v1
/
webhooks
/
{id}
Update Webhook
curl --request PUT \
  --url https://api.agentwallex.com/api/v1/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "events": [
    "payment.completed",
    "payment.failed",
    "policy.violated",
    "agent.frozen"
  ]
}
'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

​
Paramètres de chemin

​
id
string
requis
ID du Webhook à mettre à jour (par exemple, whk_abc123).

​
Corps de la requête

​
url
string
URL HTTPS mise à jour du point de terminaison Webhook.
​
events
string[]
Liste mise à jour des types d’événements auxquels s’abonner.
​
secret
string
Secret de signature mis à jour. Doit commencer par whsec_.

​
Exemple

curl -X PUT https://api.agentwallex.com/api/v1/webhooks/whk_abc123 \
  -H "X-API-Key: awx_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "events": ["payment.completed", "payment.failed", "policy.violated", "agent.frozen"]
  }'

Autorisations

​
X-API-Key
string
header
requis

API key authentication. Keys are prefixed with awx_.

Paramètres de chemin

​
id
string
requis

The webhook ID to update (e.g., whk_abc123).

Corps

application/json
​
url
string<uri>

Updated HTTPS URL for the webhook endpoint.

​
events
string[]

Updated list of event types to subscribe to.

​
secret
string

Updated signing secret. Must start with whsec_.

Réponse

Webhook updated successfully.

A registered webhook endpoint for receiving real-time event notifications.

​
id
string

Unique webhook identifier (e.g., whk_abc123).

​
url
string<uri>

HTTPS URL that receives webhook events.

​
events
string[]

List of subscribed event types.

​
status
enum<string>

Webhook status.

Options disponibles:
active,
inactive
​
created_at
string<date-time>

ISO 8601 creation timestamp.