SuitePortal

Webhooks

Receive real-time notifications via webhooks.

Webhooks

This documentation is currently being developed. Check back soon for complete content.

Overview

Webhooks allow your application to receive real-time notifications when events occur in SuitePortal.

Available Events

Sync Events

  • sync.started
  • sync.completed
  • sync.failed

Payment Events

  • payment.created
  • payment.failed
  • payment.refunded

User Events

  • user.created
  • user.invited

Webhook Payload

{
  "id": "evt_123",
  "type": "payment.created",
  "created": "2025-01-03T12:00:00Z",
  "data": {
    "object": {
      "id": "pay_456",
      "amount": 15000,
      "currency": "usd"
    }
  }
}

Signature Verification

Verify webhook authenticity:

const crypto = require('crypto');

function verifyWebhook(payload, signature, secret) {
  const expected = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');
  
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expected)
  );
}

Configuration

Configure webhooks at Settings > Webhooks.