Webhooks

Abowire can send Webhook events to your application on specific actions.

You must specify the event you would like to be notified on and a public URL that Abowire can reach. You can add custom query parameters to the request as well, such as a secret token to validate the request, etc.

The webhook object

The webhook object represents a Webhook definition in Abowire.

{
  "id": string,
  "eventArn": string,
  "url": string,
  "status": "enabled" | "disabled"
}

The webhook event

{
  "id": string,             // Webhook UUID
  "eventArn": string,       // Event ARN
  "component": string,      // Abowire module responsible for the event
  "action": string,         // Action that was triggered
  "userId": string,         // User ID who caused the event to trigger
  "timestamp": Date,        // Timestamp of the event
  "origin": string,         // Origin of the event
  "destination": string,    // Destination URL of the event
  "payload": any            // Object that was affected
}

Error Handling

The destination server must respond with HTTP status code 200 or to be considered a valid request.

Abowire will try to deliver the Webhook event 3 times, with a 5, 10 and 15 second delay between retries

(respectively ).

Subscription Management events

Event	Description
invoice:create	An Invoice was created
payment:create	A Payment was created (could still be pending capture)
payment:accepted	A Payment was captured
payment:declined	A Payment was declined
product:create	A Product was created
product:update	A Payment was updated (eg. plan was updated)
subscriber:create	A Subscriber was created
subscriber:update	A Subscriber was updated (eg. updated billing information)
subscription:create	A Subscription was created
subscription:update	A Subscription was updated (eg. changed the pricing)

Account Management events

Event	Description
account:update	Your Account information was updated (eg. updated billing information)
account-subaccount:create	A Subaccount was created (eg. Organization)
account-subaccount:update	A Subaccount was updated (eg. updated billing information of an Organization)
api-key:create	An API Key was created
api-key:revoke	An API Key was revoked

License Management events

Event	Description
subscription:disable	A Subscription License was disabled
subscription:enable	A Subscription License was enabled
subscription:bulk-enable	A list of Subscription Licenses was enabled
subscription:bulk-disable	A list of Subscription Licenses was disabled