search

Webhooks

Setup webhooks through the API in order to be notified of any Vibrant events.

curl -X 'POST' \
  'https://pos-api.sandbox.vibrant.app/pos/v1/webhooks' \
  -H 'accept: application/json' \
  -H 'apikey: vibrant_pos.YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "enabledEvents": [   
    "payment_intent.succeeded"
  ],
  "description": "My PI succeeded webhook",
  "url": "https://myPlaceToReceiveWebhhoks.com/thanks",
  "status": "enabled"
  "metadata": {
    "remember_this": "something"
  }
}'

enabledEvents

It is possible to subscribe to one or more event types or * to get all events.

See the full list of possible event types in the API documentation: REST API doc create webhookarrow-up-right

url

The endpoint to which the events will be posted.

status

Here it is possible to enable or disable the webhook.

metadata

If desired it is possible to add some meta data to the webhook that can be retrieved again when getting the webhook object. The meta data will not be attached to the events.

hashtag
Create a webhook

post
Authorizations
apikeystringRequired
Header parameters
Idempotency-KeystringOptional

To perform an idempotent request, provide an Idempotency-Key: header to the request.

Body
enabledEventsstring[]Required

The list of events to enable for this endpoint. You may specify [’*’] to enable all events, except those that require explicit selection.

Default: ["*","balance.available","card_transaction.created","card_transaction.updated","charge.created","charge.failed","charge.pending","charge.refunded","charge.refund.updated","charge.succeeded","charge.updated","file.created","file.deleted","file.updated","location.created","location.deleted","location.updated","order.created","order.deleted","order.updated","payment_intent.canceled","payment_intent.created","payment_intent.payment_failed","payment_intent.processing","payment_intent.requires_action","payment_intent.requires_confirmation","payment_intent.requires_payment_method","payment_intent.succeeded","payout.canceled","payout.created","payout.failed","payout.paid","payout.updated","product.created","product.deleted","product.updated","refund.canceled","refund.created","refund.failed","refund.processing","refund.requires_confirmation","refund.requires_payment_method","refund.succeeded","spot.created","spot.deleted","spot.updated","terminal.action_canceled","terminal.action_failed","terminal.action_in_progress","terminal.action_succeeded","terminal.created","terminal.updated","trxn.created","user.created","user.deleted","user.updated","webhook.created","webhook.updated"]
descriptionstringOptional

Add a small description to your webhook

Default: My new and dandy webhook
metadataobjectOptional
urlstringRequired

The URL of the webhook endpoint.

Default: https://myPlaceToReceiveWebhhoks.com/thanks
statusstringRequired

Enables or Disables the webhook

Default: enabled
Responses
chevron-right
201Success
application/json
idstringRequired

Unique webhook id defined by Vibrant

Default: we_wR7yMtTjefcSQjtgngVNkp
objectstringRequired

Object type

Default: webhook
accountIdstringRequired

account id of your account

Default: acct_wx7yMtTjefcSQjtgngVNkp
apiVersionstringRequired

Api version of this webhook

Default: v1
creatednumberRequired

UnixtimeStamp when the webhook was created

Default: 1671087901251
updatednumberRequired

UnixtimeStamp when the webhook was updated

Default: 1671087901251
descriptionstringRequired

Custom description added to the webhook

Default: Custom descirption added
enabledEventsstring[]Required

Events enabled for this webhook: balance.available,card_transaction.created,card_transaction.updated,charge.created,charge.failed,charge.pending,charge.refunded,charge.refund.updated,charge.succeeded,charge.updated,file.created,file.deleted,file.updated,location.created,location.deleted,location.updated,order.created,order.deleted,order.updated,payment_intent.canceled,payment_intent.created,payment_intent.payment_failed,payment_intent.processing,payment_intent.requires_action,payment_intent.requires_confirmation,payment_intent.requires_payment_method,payment_intent.succeeded,payout.canceled,payout.created,payout.failed,payout.paid,payout.updated,product.created,product.deleted,product.updated,refund.canceled,refund.created,refund.failed,refund.processing,refund.requires_confirmation,refund.requires_payment_method,refund.succeeded,spot.created,spot.deleted,spot.updated,terminal.action_canceled,terminal.action_failed,terminal.action_in_progress,terminal.action_succeeded,terminal.created,terminal.updated,trxn.created,user.created,user.deleted,user.updated,webhook.created,webhook.updated

Default: ["charge.succeeded"]
statusstringRequired

Events enabled for this webhook

Default: enabled
urlstringRequired

The url this webhooks should POST against

Default: enabled
secretstringRequired

NOT IMPLEMENTED YET - this secret should be used to validate the request Vibrant will be sending you

Default: 234lkjsdklfjkjfSDFSDFKSDJFSDKSSSQ#€€%%%#
metadataobjectOptional

All custom values in here

Default: {"remember_this": "something"}
post
/pos/v1/webhooks

hashtag
Receiving a webhook

Once a webhook was created successfully, the url defined on the webhook will start receiving the events selected on the enabledEvents field.

It's important to verify the vibrant-signature in order for you to ensure that the message received is from vibrant. More details on the vibrant-signature can be read just in the next section: Webhook event verification

And example scenario of the payload sent by Vibrant follows:

Headers

Name
Value

Content-Type

application/json

vibrant-signature

t=123132131,v0=213cds123ds12es231ds132ds123

Body

hashtag
Webhook event verification

Each webhook created in Vibrant holds a secret key.

This can be used to verify that the events posted to your webhook url is actually coming from Vibrant.

The secret key can be used to calculate an expected hash from a received message, to validate that the message in fact is from Vibrant and to this unique webhook.

How to verify messages:

Messages to a webhook hold a header named Vibrant-Signature.

The signature holds a timestamp and a hash, with comma in between.

t=1652744532,v0=1327f867e7efdzecb36ahfg46cgfs4fa51cad7e57f5g59pf736d6ce8f406d3fv

Follow these three steps to verify the Vibrant signature.

  1. Create a string combining the value of timestamp t then a . and then the message body.

  2. Compute a HMAC with the SHA256 hash function. Use the endpoint’s secret key as the key, and use the string from step 1. as the message.

  3. Compare the Vibrant signature v0 from the header to the expected signature from step 2. For an equality match, compute the difference between the current timestamp and the received timestamp, then decide if the difference is within your tolerance.

The timestamp is used to prevent replay attacks resending a valid message to your endpoint. So you can check if the timestamp is too old.

hashtag
Webhook Retrial behaviour

Upon the registration of the webhook, Vibrant will initiate delivery attempts for the selected events specified during the webhook creation process. In the event of a delivery failure, Vibrant will engage in a series of retransmission attempts employing an exponential backoff strategy, initially prioritizing expedited delivery followed by subsequent attempts spread over a maximum period of 31 days.

hashtag
Webhooks best practices

These are some of the practices recommended by Vibrant for a smooth webhook integration.

Acknowledgement of the webhooks

Upon receipt of a webhook from our system, it is imperative that the customer endpoint service promptly acknowledges receipt by sending a HTTP 200 OK response. This response serves as confirmation that the webhook payload has been successfully received and acknowledged by the third-party system. Failure to promptly respond with a 200 status code will result in unintended consequences, such as repeated delivery attempts.

PreviousTerminal actionsNextPayouts

Last updated