Skip to main content
PATCH
/
v1
/
webhooks
/
{webhook_id}
curl
curl -X PATCH "https://api.services.payward.com/v1/webhooks/whk_01J0M7C0Z9F8YX3GQH8E" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN" \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "events": [
      "quote.executed"
    ]
  }'
{
  "data": {
    "webhook": {
      "id": "whk_01J0M7C0Z9F8YX3GQH8E",
      "url": "https://example.com/webhooks/payward",
      "enabled": true,
      "subscribed_events": [
        "transfer.completed",
        "transfer.failed",
        "swap.completed"
      ],
      "available_events": [
        "transfer.completed",
        "transfer.failed",
        "swap.completed",
        "swap.failed",
        "deposit.completed",
        "withdrawal.completed",
        "withdrawal.failed"
      ],
      "created_at": "2025-12-01T10:00:00Z",
      "updated_at": "2026-04-22T08:14:32Z"
    }
  }
}

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Headers

Idempotency-Key
string<uuid>

Client-generated UUIDv4 for safe retries. Sent as the Idempotency-Key HTTP header. Replayed responses include the Idempotent-Replayed: true header.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

webhook_id
string
required

Unique identifier for the webhook

Example:

"WHTEST-XXXXX-EXAMPLE"

Body

application/json
enabled
boolean

Whether the webhook should be enabled or disabled

Example:

true

events
string[]

List of event types to subscribe to. This replaces all existing event subscriptions. Pass an empty array [] to unsubscribe from all events.

Maximum array length: 50
Maximum string length: 100
Pattern: ^[a-zA-Z0-9._]+$
Example:
["quote.executed"]

Response

Webhook updated successfully

data
object
required