Webhook
Provides webhook functionality for integrating with external services and receiving real-time notifications and data updates.
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
POST
# Register Subscriber.
PUT
# Update Subscriber.
GET
# List subscribers by company
PUT
# Register Subscriber.
GET
# Get a subscriber
GET
# List subscribers by extension ID
Parameters
company_id
integer
Required
Request body
name
string
Required
The name of the subscriber.
type
string
Nullable
The type of the subscriber, which may be null.
webhook_url
string
The URL for the subscriber's webhook.
provider
string
Required
The provider of the subscriber.
Enum
association
object (Association)
Required
Association
application_id
array of string
A list of application IDs associated with the association.
extension_id
string
The extension ID associated with the association.
criteria
string
The criteria for the association, such as "ALL", "EMPTY", or "SPECIFIC-EVENTS".
Enum
custom_headers
object
Custom headers for the subscriber.
status
object (SubscriberStatus)
Required
Enum
email_id
string
Required
The email ID associated with the subscriber.
auth_meta
object (AuthMeta)
AuthMeta
type
string
The type of authentication method used.
Enum
secret
string
The secret key or token used for authentication.
events
array of object (Events)
Required
The list of events associated with the subscriber.
Array of Events
slug
string
The slug or identifier for the event.
topic
string
The topic associated with the event.
queue
string
The queue associated with the event in case of provider as Pub/Sub.
event_bridge_name
string
The name of the event bridge associated with the event in case of provider as AWS event bridge.
workflow_name
string
The name of the workflow related to the event in case of provider as temporal.
detail_type
string
The type of detail for the event.
Response
200
Success
SubscriberConfigResult
id
integer
| int32
The unique identifier of the subscriber configuration.
modified_by
string
The identifier of the user who last modified the subscriber configuration.
name
string
The name of the subscriber.
webhook_url
string
The URL for the subscriber's webhook.
provider
string
The provider of the subscriber.
Enum
association
object (AssociationResp)
AssociationResp
company_id
integer
| int32
The ID of the company associated with the response.
application_id
array of string
A list of application IDs associated with the response.
extension_id
string
The extension ID associated with the response.
criteria
string
The criteria for the response, such as "ALL", "EMPTY", or "SPECIFIC-EVENTS".
Enum
custom_headers
object
Custom headers for the subscriber.
status
object (SubscriberStatus)
Enum
email_id
string
The email ID associated with the subscriber.
updated_on
string
| date-time
The date and time when the subscriber was last updated.
created_on
string
| date-time
The date and time when the subscriber was created.
type
string
Nullable
The type of the subscriber, which can be null.
auth_meta
object (AuthMeta)
AuthMeta
type
string
The type of authentication method used.
Enum
secret
string
The secret key or token used for authentication.
event_id
array of integer
The list of event IDs associated with the subscriber.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
Request body
id
integer
| int32
Required
The unique identifier of the subscriber to be updated.
name
string
The name of the subscriber.
type
string
Nullable
The type of the subscriber, which may be null.
webhook_url
string
The URL for the subscriber's webhook.
provider
string
Required
The provider of the subscriber.
Enum
association
object (Association)
Association
application_id
array of string
A list of application IDs associated with the association.
extension_id
string
The extension ID associated with the association.
criteria
string
The criteria for the association, such as "ALL", "EMPTY", or "SPECIFIC-EVENTS".
Enum
custom_headers
object
Custom headers for the subscriber.
status
object (SubscriberStatus)
Required
Enum
email_id
string
The email ID associated with the subscriber.
auth_meta
object (AuthMeta)
AuthMeta
type
string
The type of authentication method used.
Enum
secret
string
The secret key or token used for authentication.
events
array of object (Events)
The list of events associated with the subscriber.
Array of Events
slug
string
The slug or identifier for the event.
topic
string
The topic associated with the event.
queue
string
The queue associated with the event in case of provider as Pub/Sub.
event_bridge_name
string
The name of the event bridge associated with the event in case of provider as AWS event bridge.
workflow_name
string
The name of the workflow related to the event in case of provider as temporal.
detail_type
string
The type of detail for the event.
Response
200
Success
SubscriberConfigResult
id
integer
| int32
The unique identifier of the subscriber configuration.
modified_by
string
The identifier of the user who last modified the subscriber configuration.
name
string
The name of the subscriber.
webhook_url
string
The URL for the subscriber's webhook.
provider
string
The provider of the subscriber.
Enum
association
object (AssociationResp)
AssociationResp
company_id
integer
| int32
The ID of the company associated with the response.
application_id
array of string
A list of application IDs associated with the response.
extension_id
string
The extension ID associated with the response.
criteria
string
The criteria for the response, such as "ALL", "EMPTY", or "SPECIFIC-EVENTS".
Enum
custom_headers
object
Custom headers for the subscriber.
status
object (SubscriberStatus)
Enum
email_id
string
The email ID associated with the subscriber.
updated_on
string
| date-time
The date and time when the subscriber was last updated.
created_on
string
| date-time
The date and time when the subscriber was created.
type
string
Nullable
The type of the subscriber, which can be null.
auth_meta
object (AuthMeta)
AuthMeta
type
string
The type of authentication method used.
Enum
secret
string
The secret key or token used for authentication.
event_id
array of integer
The list of event IDs associated with the subscriber.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
PUT
Response
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 (SubscriberDetails)
Array of SubscriberDetails
id
integer
| int32
The unique identifier of the subscriber.
modified_by
string
The identifier of the user who last modified the subscriber details.
name
string
The name of the subscriber.
provider
string
The provider of the subscriber.
Enum
webhook_url
string
The URL for the subscriber's webhook.
association
object (AssociationResp)
AssociationResp
company_id
integer
| int32
The ID of the company associated with the response.
application_id
array of string
A list of application IDs associated with the response.
extension_id
string
The extension ID associated with the response.
criteria
string
The criteria for the response, such as "ALL", "EMPTY", or "SPECIFIC-EVENTS".
Enum
custom_headers
object
Nullable
Custom headers for the subscriber.
status
object (SubscriberStatus)
Enum
email_id
string
The email ID associated with the subscriber.
updated_on
string
| date-time
The date and time when the subscriber details were last updated.
created_on
string
| date-time
The date and time when the subscriber was created.
type
string
Nullable
The type of subscriber, which can either be passed as null.
auth_meta
object (AuthMeta)
AuthMeta
type
string
The type of authentication method used.
Enum
secret
string
The secret key or token used for authentication.
event_configs
array of object (EventConfig)
Array of EventConfig
id
integer
The unique identifier for the event configuration.
type
string
Nullable
The type of event configuration, which may be null.
event_name
string
The name of the event.
event_type
string
The type of the event.
event_category
string
The category of the event.
modified_by
string
The identifier of the user who last modified the event configuration.
subscriber_event_mapping
object (SubscriberEventMapping)
SubscriberEventMapping
id
number
The unique identifier for the subscriber event mapping.
event_id
number
The ID of the event associated with the subscriber.
subscriber_id
number
The ID of the subscriber.
broadcaster_config
object (BroadcasterConfig)
Nullable
BroadcasterConfig
topic
string
The name of the topic for the broadcaster configuration.
queue
string
The name of the queue for the broadcaster configuration.
event_bridge_name
string
The name of the event bridge associated with the broadcaster.
workflow_name
string
The name of the workflow related to the broadcaster.
account_id
string
The account ID associated with the broadcaster.
detail_type
string
The type of detail for the broadcaster configuration.
created_on
string
| date-time
The date and time when the subscriber event mapping was created.
event_schema
object
Nullable
The schema for the event, allowing for additional properties and may be null.
group
string
Nullable
The group associated with the event configuration, which may be null.
version
string
The version of the event configuration.
display_name
string
The display name of the event configuration.
description
string
Nullable
A description of the event configuration, which may be null.
created_on
string
| date-time
The date and time when the event configuration was created.
updated_on
string
| date-time
The date and time when the event configuration was last updated.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
page_no:
1
page_size:
10
extension_id:
"652255c58ab4101b2595c6c5"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
Request body
webhook_config
object (WebhookConfig)
Required
WebhookConfig
notification_email
string
The email address for notifications.
name
string
The name of the webhook configuration.
status
string
The status of the webhook (e.g., active or inactive).
Enum
association
object (Association)
Association
application_id
array of string
A list of application IDs associated with the association.
extension_id
string
The extension ID associated with the association.
criteria
string
The criteria for the association, such as "ALL", "EMPTY", or "SPECIFIC-EVENTS".
Enum
event_map
object (EventMapBody)
EventMapBody
rest
object (RestConfig)
RestConfig
webhook_url
string
Required
The URL for the webhook.
type
string
Required
The type of the configuration.
custom_headers
object
Custom headers for the configuration.
auth_meta
object (AuthMeta)
AuthMeta
type
string
The type of authentication method used.
Enum
secret
string
The secret key or token used for authentication.
events
array of object (RestEventData)
Required
Array of RestEventData
event_category
string
Required
The category of the event.
event_name
string
Required
The name of the event.
event_type
string
Required
The type of the event.
version
number
Required
The version number of the event.
kafka
object (KafkaConfig)
KafkaConfig
type
string
Nullable
events
array of object (QueueEventData)
Required
Array of QueueEventData
event_category
string
Required
The category of the event.
event_name
string
Required
The name of the event.
event_type
string
Required
The type of the event.
version
number
Required
The version number of the event.
topic
string
Required
The topic associated with the event.
pub_sub
object (PubSubConfig)
PubSubConfig
type
string
Nullable
events
array of object (QueueEventData)
Required
Array of QueueEventData
event_category
string
Required
The category of the event.
event_name
string
Required
The name of the event.
event_type
string
Required
The type of the event.
version
number
Required
The version number of the event.
topic
string
Required
The topic associated with the event.
temporal
object (TemporalConfig)
TemporalConfig
type
string
Nullable
events
array of object (TemporalEventData)
Required
Array of TemporalEventData
event_category
string
Required
The category of the event.
event_name
string
Required
The name of the event.
event_type
string
Required
The type of the event.
version
number
Required
The version number of the event.
queue
string
The queue associated with the event.
workflow_name
string
The workflow name related to the event.
sqs
object (SqsConfig)
SqsConfig
type
string
Nullable
events
array of object (SqsEventData)
Required
Array of SqsEventData
event_category
string
Required
The category of the event.
event_name
string
Required
The name of the event.
event_type
string
Required
The type of the event.
version
number
Required
The version number of the event.
queue
string
The queue name associated with the event in SQS.
event_bridge
object (EventBridgeConfig)
EventBridgeConfig
type
string
Nullable
events
array of object (EventBridgeData)
Required
Array of EventBridgeData
event_category
string
Required
The category of the event.
event_name
string
Required
The name of the event.
event_type
string
Required
The type of the event.
version
number
Required
The version number of the event.
event_bridge_name
string
The name of the event bridge related to the event.
Response
200
Success
UpsertSubscriberConfigResult
status
boolean
The status of the upsert operation (e.g., success or failure).
message
string
A message providing details about the upsert operation result.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
integer
Required
subscriber_id
integer
Required
subscriber id
Response
200
Success
SubscriberDetails
id
integer
| int32
The unique identifier of the subscriber.
modified_by
string
The identifier of the user who last modified the subscriber details.
name
string
The name of the subscriber.
provider
string
The provider of the subscriber.
Enum
webhook_url
string
The URL for the subscriber's webhook.
association
object (AssociationResp)
AssociationResp
company_id
integer
| int32
The ID of the company associated with the response.
application_id
array of string
A list of application IDs associated with the response.
extension_id
string
The extension ID associated with the response.
criteria
string
The criteria for the response, such as "ALL", "EMPTY", or "SPECIFIC-EVENTS".
Enum
custom_headers
object
Nullable
Custom headers for the subscriber.
status
object (SubscriberStatus)
Enum
email_id
string
The email ID associated with the subscriber.
updated_on
string
| date-time
The date and time when the subscriber details were last updated.
created_on
string
| date-time
The date and time when the subscriber was created.
type
string
Nullable
The type of subscriber, which can either be passed as null.
auth_meta
object (AuthMeta)
AuthMeta
type
string
The type of authentication method used.
Enum
secret
string
The secret key or token used for authentication.
event_configs
array of object (EventConfig)
Array of EventConfig
id
integer
The unique identifier for the event configuration.
type
string
Nullable
The type of event configuration, which may be null.
event_name
string
The name of the event.
event_type
string
The type of the event.
event_category
string
The category of the event.
modified_by
string
The identifier of the user who last modified the event configuration.
subscriber_event_mapping
object (SubscriberEventMapping)
SubscriberEventMapping
id
number
The unique identifier for the subscriber event mapping.
event_id
number
The ID of the event associated with the subscriber.
subscriber_id
number
The ID of the subscriber.
broadcaster_config
object (BroadcasterConfig)
Nullable
BroadcasterConfig
topic
string
The name of the topic for the broadcaster configuration.
queue
string
The name of the queue for the broadcaster configuration.
event_bridge_name
string
The name of the event bridge associated with the broadcaster.
workflow_name
string
The name of the workflow related to the broadcaster.
account_id
string
The account ID associated with the broadcaster.
detail_type
string
The type of detail for the broadcaster configuration.
created_on
string
| date-time
The date and time when the subscriber event mapping was created.
event_schema
object
Nullable
The schema for the event, allowing for additional properties and may be null.
group
string
Nullable
The group associated with the event configuration, which may be null.
version
string
The version of the event configuration.
display_name
string
The display name of the event configuration.
description
string
Nullable
A description of the event configuration, which may be null.
created_on
string
| date-time
The date and time when the event configuration was created.
updated_on
string
| date-time
The date and time when the event configuration was last updated.
Examples
Parameters
company_id:
1
subscriber_id:
1
Was this section helpful?
GET
Response
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 (SubscriberDetails)
Array of SubscriberDetails
id
integer
| int32
The unique identifier of the subscriber.
modified_by
string
The identifier of the user who last modified the subscriber details.
name
string
The name of the subscriber.
provider
string
The provider of the subscriber.
Enum
webhook_url
string
The URL for the subscriber's webhook.
association
object (AssociationResp)
AssociationResp
company_id
integer
| int32
The ID of the company associated with the response.
application_id
array of string
A list of application IDs associated with the response.
extension_id
string
The extension ID associated with the response.
criteria
string
The criteria for the response, such as "ALL", "EMPTY", or "SPECIFIC-EVENTS".
Enum
custom_headers
object
Nullable
Custom headers for the subscriber.
status
object (SubscriberStatus)
Enum
email_id
string
The email ID associated with the subscriber.
updated_on
string
| date-time
The date and time when the subscriber details were last updated.
created_on
string
| date-time
The date and time when the subscriber was created.
type
string
Nullable
The type of subscriber, which can either be passed as null.
auth_meta
object (AuthMeta)
AuthMeta
type
string
The type of authentication method used.
Enum
secret
string
The secret key or token used for authentication.
event_configs
array of object (EventConfig)
Array of EventConfig
id
integer
The unique identifier for the event configuration.
type
string
Nullable
The type of event configuration, which may be null.
event_name
string
The name of the event.
event_type
string
The type of the event.
event_category
string
The category of the event.
modified_by
string
The identifier of the user who last modified the event configuration.
subscriber_event_mapping
object (SubscriberEventMapping)
SubscriberEventMapping
id
number
The unique identifier for the subscriber event mapping.
event_id
number
The ID of the event associated with the subscriber.
subscriber_id
number
The ID of the subscriber.
broadcaster_config
object (BroadcasterConfig)
Nullable
BroadcasterConfig
topic
string
The name of the topic for the broadcaster configuration.
queue
string
The name of the queue for the broadcaster configuration.
event_bridge_name
string
The name of the event bridge associated with the broadcaster.
workflow_name
string
The name of the workflow related to the broadcaster.
account_id
string
The account ID associated with the broadcaster.
detail_type
string
The type of detail for the broadcaster configuration.
created_on
string
| date-time
The date and time when the subscriber event mapping was created.
event_schema
object
Nullable
The schema for the event, allowing for additional properties and may be null.
group
string
Nullable
The group associated with the event configuration, which may be null.
version
string
The version of the event configuration.
display_name
string
The display name of the event configuration.
description
string
Nullable
A description of the event configuration, which may be null.
created_on
string
| date-time
The date and time when the event configuration was created.
updated_on
string
| date-time
The date and time when the event configuration was last updated.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
page_no:
1
page_size:
10
company_id:
1
extension_id:
"652255c58ab4101b2595c6c5"
Was this section helpful?
GET
Response