Webhooks are useful when you want to send the data to another domain if a bin is Created, Updated or Deleted.

Configure

Navigate to Webhooks(requires auth) page on your Dashboard to configure Webhooks.

Here, you can set the Endpoint URL where you would like to receive the Webhooks. Currently, you can receive webhooks for the Core API only, i.e, for the bins you Create, Update and Delete.

Control

Webhooks will enable when a valid URL endpoint is provided.

You can decide for what actions you need the Webhooks for by simply ticking the Checkboxes for each action.

Webhooks will not be sent for the Endpoints not checked.

Moreover, you can also Pause & Continue with the Webhooks using the Pause and Play button besides Reset Webhook option.

Reset

You can all-together Reset the Webhooks by using the Reset Button.

Resetting will reset all the Webhooks Configuration, including Endpoint URL.

Response Objects

Each Action will have a unique Response, and it's similar to the Response you receive when Creating, Updating or Deleting Bins.

CREATE Webhook Response Details

{
  data: {
    <BIN_DATA>
  },
  id: <YOUR_BIN_ID>,
  collectionID: <YOUR_COLLECTION_ID>, //if bin was added to a collection
  private: true, //if bin was created as a Private bin
  binName: 'jandu', //if name header was passed when creating a Bin
  webhookInfo: {
    requestType: 'create',
    recordType: 'bin'
  }
}

UPDATE Webhook Response Details

{
  data: {
    <BIN_DATA>
  },
  parentId: <BIN_ID>,
  version: <BIN_VERSION>,
  versioning: false, //if versioning is disabled while updating
  webhookInfo: {
    requestType: 'update',
    recordType: 'bin'
  }
}

DELETE Webhook Response Details

{
  id: <BIN_ID>,
  message: 'Bin <BIN_ID> is deleted successfully. <BIN_VERSION_COUNT> versions removed.',
  webhookInfo: {
    requestType: 'delete',
    recordType: 'bin'
  }
}