Webhooks

Retrieve Message to Sign for Webhook Subscription

Generates a message for the user to sign. This message must be sent on POST /api/v1/webhooks/subscribe/{partnerId} to subscribe to webhook notifications.

get/api/v1/webhooks/message/{partnerId}

Request

Base URL
https://api.gnosispay.com
Auth
none required
TypeScript
https://skmtc.dev/gnosispay/apis/gnosispay-api/docs/api/v1/webhooks/message/:partnerId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

partnerIdstring required

Partner ID to subscribe to

Query parameters

walletAddressstring

Optional Ethereum wallet address to use for signing. Must be one of the user's verified EOA addresses. If not provided, defaults to the user's primary verified wallet.

Response

Message generated successfully

messagestring

SIWE message to be signed by the user

noncestring

Unique nonce for this subscription request

Changes

No recorded changes to this operation across all 1 revision of this API.