Skip to main content
POST
/
api
/
v1
/
webhooks
/
subscribe
/
{partnerId}
Subscribe to Webhooks
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({message: '<string>', signature: '<string>'})
};

fetch('https://api.gnosispay.com/api/v1/webhooks/subscribe/{partnerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "subscriptionId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gnosispay.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
partnerId
string
required

Partner ID to subscribe to

Body

application/json
​
message
string
required

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

​
signature
string
required

Signature of the message by the user's wallet

Response

Successfully subscribed to partner webhooks

​
success
boolean

Whether the subscription was successful

​
subscriptionId
string

Unique ID of the created subscription