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

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
{
  "success": true,
  "subscriptionId": "<string>"
}

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