Webhook

Eshopbox observes several events that you can attach webhooks to. With a webhook, you can attach custom code that performs actions outside of the Eshopbox ecosystem.

You may want to send a survey email after an order is fulfilled. You can do this via a webhook that sends event data to your custom function.

Event Object

Attributes
Sample Json
Attributes

Attribute

Type

Description

id

string

Unique identifier for the registered events.

resource

string

The resources affected by this event. Refer here for resource types available.

eventType

string

It describes the CRUD format of event .

Example: POST ,PUT etc.

eventSubType

string

This defines the event verb specifically for an event Type.

version

string

It is used for versioning the Events.

externalChannelID

string

The channel which has registered for the webhook

webhookUrl

number

The url of the API outside Eshopbox domain which is supposed to be triggered

webhookMethod

object

The Rest API signature required to create a request .Example- GET ,PUT , POST , DELETE

Sample Json
{
"id":"1",
"resource": "channel_inventory",
"eventType": "POST",
"eventSubType": "updated",
"version": "v1",
"externalChannelID" : "TATA CLIQ VELOCY KAPAS KRAFT",
"webhookUrl": "https://hooks.zapier.com/fake-subscription-url",
"webhookMethod": "POST"
}