TrieOH
PayssageAPIWebhooks

Create a webhook endpoint

Registers a tenant webhook endpoint on the wallet. Payssage will POST provider events to `url` (see the top-level "Webhooks for tenants" section for the delivery envelope and signature headers). The returned `secret` is used to verify the `X-Payssage-Signature` header on each delivery. The actor must own the wallet.

POST/wallets/{wallet_id}/webhooks/endpoints

Registers a tenant webhook endpoint on the wallet. Payssage will POST provider events to url (see the top-level "Webhooks for tenants" section for the delivery envelope and signature headers). The returned secret is used to verify the X-Payssage-Signature header on each delivery. The actor must own the wallet.

Authorization

AuthorizationBearer <token>

JWT issued by IdentityX, signed with Ed25519

In: header

Path Parameters

wallet_id*string

Wallet ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for webhook endpoint creation. Mirrors models.CreateWebhookEndpointRequest.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/webhooks/endpoints" \  -H "Content-Type: application/json" \  -d '{    "name": "Payment events",    "url": "https://app.example.com/webhooks/payments"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",
  "name": "string",
  "url": "http://example.com",
  "secret": "string",
  "created_at": "2019-08-24T14:15:22Z"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 400,
  "title": "Validation Failed"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 401,
  "title": "Unauthenticated"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 403,
  "title": "Insufficient Role"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 404,
  "title": "Not Found"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 500,
  "title": "Internal Server Error"
}