TrieOH
PayssageAPIWebhooks

Get a webhook endpoint

Fetches a single webhook endpoint by ID.

GET/webhooks/endpoints/{endpoint_id}

Fetches a single webhook endpoint by ID.

Authorization

bearerAuth
AuthorizationBearer <token>

JWT issued by IdentityX, signed with Ed25519

In: header

Path Parameters

endpoint_id*string

Webhook endpoint ID.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/webhooks/endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "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": 401,
  "title": "Unauthenticated"
}
{
  "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"
}

Create a webhook endpoint POST

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.

Delete a webhook endpoint DELETE

Deletes a webhook endpoint and stops future deliveries to it.