Webhooks

Webhooks enable real-time communication between ShipOS and your application, ensuring your system stays synchronized with user actions, billing events, and system changes as they happen.

ShipOS webhooks are reliable and secure, featuring automatic retry logic, signature verification, and comprehensive event logging. The system tracks delivery success and provides debugging tools for failed webhook deliveries to maintain data consistency.

Setting up webhook endpoints with event filtering and security:

const webhook = await shipos.webhooks.create({
  url: 'https://yourapp.com/webhooks/shipos',
  events: ['user.created', 'subscription.updated'],
  secret: 'your_webhook_secret'
});

// Verify signatures in your endpoint
const isValid = shipos.webhooks.verifySignature(
  payload, signature, webhookSecret
);

const webhook = await shipos.webhooks.create({
  url: 'https://yourapp.com/webhooks/shipos',
  events: ['user.created', 'subscription.updated'],
  secret: 'your_webhook_secret'
});

// Verify signatures in your endpoint
const isValid = shipos.webhooks.verifySignature(
  payload, signature, webhookSecret
);

const webhook = await shipos.webhooks.create({
  url: 'https://yourapp.com/webhooks/shipos',
  events: ['user.created', 'subscription.updated'],
  secret: 'your_webhook_secret'
});

// Verify signatures in your endpoint
const isValid = shipos.webhooks.verifySignature(
  payload, signature, webhookSecret
);

The webhook payload includes comprehensive event data with before and after states for update events. This allows your application to understand exactly what changed and respond appropriately without additional API calls to fetch context.

ShipOS automatically retries failed webhook deliveries using exponential backoff. The system attempts delivery 5 times over 24 hours before marking the webhook as failed. You can manually retry failed deliveries from the dashboard or programmatically through the API.

The webhook dashboard provides real-time monitoring with delivery status, response codes, and detailed logs. You can filter events by type, status, or time range to troubleshoot integration issues and ensure reliable event processing in your application workflows.