Webhooks

Subscribe to Webhooks

Allows a partner to receive webhook notifications for the authenticated user.

post/api/v1/webhooks/subscribe/{partnerId}

Request

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

partnerIdstring required

Partner ID to subscribe to

messagestring required

SIWE message obtained from /api/v1/webhooks/message/{partnerId}

signaturestring required

Signature of the message by the user's wallet

Successfully subscribed to partner webhooks

successboolean

Whether the subscription was successful

subscriptionIdstring

Unique ID of the created subscription

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