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 event

The event is sent as a POST request to the URL you specified. The body of the request will contain a JSON object with the following structure:

{
  "source": <source>,                   // Source of the event (see list below)
  "event": <event>,                     // Event that was fired (see list below)
  "accountId": <accountId>,             // Account ID that triggered the event
  "isProduction": <isProduction>,       // Whether the event was triggered in a production account or not
  "payload": <payload>                  // Payload of the event
  "previousPayload": <previousPayload>  // Previous version of the entity (only for update events)
}

Payload

The payload of the event contains the newly available data. The structure depends on the type of event (see in the table below).

Sources by Abowire:

• com.abowire.billing
• com.abowire.checkout
• com.abowire.identity
• com.abowire.payments
• com.abowire.notifications
• com.abowire.apps

Error Handling

You must return a 200 HTTP status code within 5 seconds to be considered a valid request. 5+10

• Responses with error codes 429 and 5xx are retried up to 3 times (after 5min, 15min and 30min since the original request).
• Responses with error codes 1xx, 2xx, 3xx, and 4xx (excluding 429) are not retried.

Your response can use the standard Retry-After header to indicate the number of seconds to wait before we try again (max. 900).

Please not that after 3 failed attempts, the webhook will be disabled and you will receive an email notification (if a Contact Email is configured).

Subscription Management events

Event	Description	Payload
customer.created	A customer was created	Customer
customer.updated	A customer was updated	Customer
product.created	A product was created	Product
product.updated	A product was updated	Product
subscription.created	A subscription was created	Subscription
subscription.updated	A subscription was updated	Subscription
subscription.renewed	A subscription was renewed	Subscription
subscription.trial_ending	A subscription is about to end its trial period	Subscription
subscription.trial_ended	A subscription ended its trial period	Subscription
subscription.upgraded	A subscription was upgraded	Subscription
subscription.downgraded	A subscription was downgraded	Subscription
subscription.canceled	A subscription was canceled	Subscription
invoice.created	An invoice was created	Invoice
creditNote.created	A credit note was created	Invoice
payment.succeeded	A payment succeeded	Transaction
payment.failed	A payment failed	Transaction
payment.refunded	A payment was refunded	Transaction
payment.refund_failed	A refund has failed	Transaction

Account Management events

Event	Description	Payload
account.updated	Your account was updated	Account
account.member_invited	A member was invited to your account	Member Invite
account.member_added	A member was approved to your account	Member
account.member_removed	A member was removed from your account	Member

License Management events

Event	Description	Payload
license.created	A license was created	License
license.updated	A license was updated	License
license.activated	A license was activated	License
license.deleted	A license was deleted	License
license_user.created	A license user was created	License User
license_user.updated	A license user was updated	License User
license_user.deleted	A license user was deleted	License User