Webhook
Provides webhook functionality for integrating with external services and receiving real-time notifications and data updates.
Webhook
You can use webhooks to receive notifications about particular events in a sales channel or platform. After you've subscribed to a webhook which can be a URL, your app can execute code immediately after specific events occur in the sales channels or platform, instead of having to make API calls periodically to check their status. For example, you can rely on webhooks to trigger an action in your sales channel when a customer creates a cart, or when a merchant creates a new product in their Fynd Platform. By using webhooks, you can make fewer API calls overall, which makes sure that your apps are more efficient and update quickly.
Operations
GET
# List event configurations
POST
# Register Subscriber.
PUT
# Update Subscriber.
POST
# Register subscriber to event
GET
# List subscribers by company
PUT
# Update a subscriber config
GET
# Get a subscriber
GET
# List subscribers by extension ID
GET
List event configurations
Retrieve all configurations for event handling.
Parameters
company_id
integer
Required
Response
200
Successfully received ping for the provided webhook url.
EventConfigResponse
event_configs
array of object (EventConfig)
Array of EventConfig
Examples
Parameters
companyId:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List event configurations
fetchAllEventConfigurations
POST
Register Subscriber.
Register Subscriber.
Parameters
company_id
integer
Required
Request body
name
string
Required
webhook_url
string
provider
string
Required
association
object (Association)
Required
Association
custom_headers
object
status
object (SubscriberStatus)
Required
Enum
email_id
string
Required
auth_meta
object (AuthMeta)
AuthMeta
events
array of object (Events)
Required
Array of Events
Response
200
Success
SubscriberConfigResponse
id
integer
| int32
modified_by
string
name
string
webhook_url
string
provider
string
association
object (AssociationResp)
AssociationResp
custom_headers
object
status
object (SubscriberStatus)
Enum
email_id
string
updated_on
string
created_on
string
type
string
Nullable
auth_meta
object (AuthMeta)
AuthMeta
event_id
array of integer
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Register Subscriber.
registerSubscriberToEventV2
PUT
Update Subscriber.
Update Subscriber.
Parameters
company_id
integer
Required
Request body
id
integer
| int32
Required
name
string
webhook_url
string
provider
string
Required
association
object (Association)
Association
custom_headers
object
status
object (SubscriberStatus)
Required
Enum
email_id
string
auth_meta
object (AuthMeta)
AuthMeta
events
array of object (Events)
Array of Events
Response
200
Success
SubscriberConfigResponse
id
integer
| int32
modified_by
string
name
string
webhook_url
string
provider
string
association
object (AssociationResp)
AssociationResp
custom_headers
object
status
object (SubscriberStatus)
Enum
email_id
string
updated_on
string
created_on
string
type
string
Nullable
auth_meta
object (AuthMeta)
AuthMeta
event_id
array of integer
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update Subscriber.
updateSubscriberV2
POST
Register subscriber to event
Add a subscriber to receive events of a specific type.
Parameters
company_id
integer
Required
Request body
name
string
Required
webhook_url
string
Required
association
object (Association)
Required
Association
custom_headers
object
status
object (SubscriberStatus)
Required
Enum
email_id
string
Required
auth_meta
object (AuthMeta)
AuthMeta
event_id
array of integer
Required
Response
200
Success
SubscriberConfigResponse
id
integer
| int32
modified_by
string
name
string
webhook_url
string
provider
string
association
object (AssociationResp)
AssociationResp
custom_headers
object
status
object (SubscriberStatus)
Enum
email_id
string
updated_on
string
created_on
string
type
string
Nullable
auth_meta
object (AuthMeta)
AuthMeta
event_id
array of integer
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Register subscriber to event
registerSubscriberToEvent
GET
List subscribers by company
Retrieve subscribers associated with a company.
Parameters
company_id
integer
Required
page_no
integer
Page Number
page_size
integer
| int32
Page Size
extension_id
string
extension_id
Response
200
Subscribers By Company ID.
SubscriberConfigList
items
array of object (SubscriberResponse)
Array of SubscriberResponse
page
object (Page)
Page
Examples
Parameters
companyId:
1
pageNo:
1
pageSize:
10
extensionId:
"64affd97cbddb85348ca8f93"
Was this section helpful?
GET
Loading...
Response
Loading...
List subscribers by company
getSubscribersByCompany
PUT
Update a subscriber config
Modify and update subscriber configuration settings.
Parameters
company_id
integer
Required
Request body
id
integer
| int32
Required
name
string
webhook_url
string
association
object (Association)
Association
custom_headers
object
status
object (SubscriberStatus)
Enum
email_id
string
auth_meta
object (AuthMeta)
AuthMeta
event_id
array of integer
Required
Response
200
Success
SubscriberConfigResponse
id
integer
| int32
modified_by
string
name
string
webhook_url
string
provider
string
association
object (AssociationResp)
AssociationResp
custom_headers
object
status
object (SubscriberStatus)
Enum
email_id
string
updated_on
string
created_on
string
type
string
Nullable
auth_meta
object (AuthMeta)
AuthMeta
event_id
array of integer
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update a subscriber config
updateSubscriberConfig
GET
Get a subscriber
Retrieve a subscriber's details by their unique identifier.
Parameters
company_id
integer
Required
subscriber_id
integer
Required
subscriber id
Response
200
Success
SubscriberResponse
id
integer
| int32
modified_by
string
name
string
provider
string
webhook_url
string
association
object (AssociationResp)
AssociationResp
custom_headers
object
status
object (SubscriberStatus)
Enum
email_id
string
updated_on
string
created_on
string
type
string
Nullable
auth_meta
object (AuthMeta)
AuthMeta
event_configs
array of object (EventConfig)
Array of EventConfig
Examples
Parameters
companyId:
1
subscriberId:
1
Was this section helpful?
GET
Loading...
Response
Loading...
Get a subscriber
getSubscriberById
GET
List subscribers by extension ID
Retrieve subscribers associated with a specific extension.
Parameters
page_no
integer
Page Number
page_size
integer
| int32
Page Size
company_id
integer
Required
extension_id
string
Required
extension_id
Response
200
Success
SubscriberConfigList
items
array of object (SubscriberResponse)
Array of SubscriberResponse
page
object (Page)
Page
Examples
Parameters
pageNo:
1
pageSize:
10
companyId:
1
extensionId:
"64affd97cbddb85348ca8f93"
Was this section helpful?
GET
Loading...
Response
Loading...