Skip to main content

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
POST
/service/platform/webhook/v1.0/company/{company_id}/retry
# Manual retry of failed event
POST
/service/platform/webhook/v1.0/company/{company_id}/retry/events/counts
# Get event counts
GET
/service/platform/webhook/v1.0/company/{company_id}/retry/status
# Get manual retry status
DEL
/service/platform/webhook/v1.0/company/{company_id}/retry/cancel
# Manual retry cancellation
POST
/service/platform/webhook/v1.0/company/{company_id}/reports/download
# Download delivery report
POST
/service/platform/webhook/v1.0/company/{company_id}/subscriber/ping
# Ping webhook
POST
/service/platform/webhook/v1.0/company/{company_id}/filters
# Get report filters
POST
/service/platform/webhook/v1.0/company/{company_id}/reports/history
# Get historical reports
GET
/service/platform/webhook/v1.0/company/{company_id}/reports/cancel/file/{filename}
# Cancel job by name
POST
/service/platform/webhook/v1.0/company/{company_id}/reports/event_processed
# Get delivery reports
GET
/service/platform/webhook/v1.0/company/{company_id}/events
# List event configurations
POST
/service/platform/webhook/v1.0/company/{company_id}/subscriber/
# Register subscriber to event
GET
/service/platform/webhook/v1.0/company/{company_id}/subscriber/
# List subscribers by company
PUT
/service/platform/webhook/v1.0/company/{company_id}/subscriber/
# Update a subscriber config
GET
/service/platform/webhook/v1.0/company/{company_id}/subscriber/{subscriber_id}
# Get a subscriber
GET
/service/platform/webhook/v1.0/company/{company_id}/extension/{extension_id}/subscriber/
# List subscribers by extension ID
POST

Manual retry of failed event

Trigger a manual retry for an event that failed to deliver.
Parameters
body
object (RetryEventRequest)
RetryEventRequest
search_text
string
Optional
end_date
string
Optional
start_date
string
Optional
subscriber_ids
array of integer
Optional
event
array of object (Event)
Optional
Array of Event
status
string
Optional
Response
200
Initiates a manual retry for event processing for a specific company. This endpoint allows the user to specify the date range (start_date and end_date) within which the events should be retried.
RetrySuccessResponse
success
boolean
Optional
message
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/webhook/v1.0/company/{company_id}/retry
Loading...
Response
Loading...
POST

Get event counts

Retrieve the counts of events based on their status.
Parameters
body
object (RetryEventRequest)
RetryEventRequest
search_text
string
Optional
end_date
string
Optional
start_date
string
Optional
subscriber_ids
array of integer
Optional
event
array of object (Event)
Optional
Array of Event
status
string
Optional
Response
200
Initiates a manual retry for event processing for a specific company. This endpoint allows the user to specify the date range (start_date and end_date) within which the events should be retried.
RetryCountResponse
items
array of object (Item)
Optional
Array of Item
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/webhook/v1.0/company/{company_id}/retry/events/counts
Loading...
Response
Loading...
GET

Get manual retry status

Check the status of a manual retry operation.
Parameters
No Parameters
Response
200
Successful response with the retry status.
RetryStatusResponse
total_event
integer
Optional
The total number of events that require retry.
success_count
integer
Optional
The count of successfully retried events.
failure_count
integer
Optional
The count of failed retry attempts.
status
string
Optional
The overall status of the retry process (e.g., "completed").
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/webhook/v1.0/company/{company_id}/retry/status
Loading...
Response
Loading...
DEL

Manual retry cancellation

Cancel a manual retry operation for a failed event.
Parameters
No Parameters
Response
200
Manual retry cancelled successfully.
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
/service/platform/webhook/v1.0/company/{company_id}/retry/cancel
Loading...
Response
Loading...
POST

Download delivery report

Download detailed delivery reports for events.
Parameters
body
object (EventProcessRequest)
EventProcessRequest
search_text
string
Optional
end_date
string
Optional
start_date
string
Optional
subscriber_ids
array of integer
Optional
status
string
Optional
event
array of object (Event)
Optional
Array of Event
Response
200
Successfully downloaded the report.
DownloadReportResponse
file_name
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/webhook/v1.0/company/{company_id}/reports/download
Loading...
Response
Loading...
POST

Ping webhook

Send a test ping to a webhook for verification.
Parameters
body
object (PingWebhook)
PingWebhook
webhook_url
string
| uri
Optional
The URL of the subscriber's webhook to ping.
auth_meta
object
Optional
Authentication metadata (if required by the subscriber).
custom_headers
object
Optional
Custom headers to include in the ping request.
Response
200
Successfully received ping for the provided webhook url.
PingWebhookResponse
status
string
Optional
The status of the ping (e.g., "SUCCESS").
message
string
Optional
An optional message related to the ping.
code
integer
Optional
The HTTP status code of the ping response (e.g., 200).
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/webhook/v1.0/company/{company_id}/subscriber/ping
Loading...
Response
Loading...
POST

Get report filters

Retrieve filters used for generating reports.
Parameters
body
object (ReportFiltersPayload)
ReportFiltersPayload
subscriber_ids
array of integer
Optional
An array of subscriber IDs for filtering filters (optional).
Response
200
Successfully retrieved the filters.
Array of ReportFilterResponse
filter_name
string
Optional
The name of the filter.
values
array of object
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/webhook/v1.0/company/{company_id}/filters
Loading...
Response
Loading...
POST

Get historical reports

Retrieve historical reports of webhook events.
Parameters
body
object (HistoryPayload)
HistoryPayload
type
string
Optional
The type of history report (e.g., "platform").
page_no
integer
Optional
The page number of the history report.
page_size
integer
Optional
The number of records per page.
Response
200
It will give list of all the reports that was downloaded.
HistoryResponse
items
array of object (HistoryItems)
Optional
Array of HistoryItems
page
object (Page)
Optional
Page
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/webhook/v1.0/company/{company_id}/reports/history
Loading...
Response
Loading...
GET

Cancel job by name

It will cancel export job triggerd by user in order to fetch historical delivery summery
Parameters
filename
string
This is filename that will be used for export operation
Response
200
Report export canceled successfully.
CancelResponse
message
string
Optional
The HTTP status code of the response (e.g., 200).
Examples
Parameters
filename:
"test_file"
Was this section helpful?
GET
/service/platform/webhook/v1.0/company/{company_id}/reports/cancel/file/{filename}
Loading...
Response
Loading...
POST

Get delivery reports

Retrieve reports on the delivery status of events.
Parameters
body
object (EventProcessRequest)
EventProcessRequest
search_text
string
Optional
end_date
string
Optional
start_date
string
Optional
subscriber_ids
array of integer
Optional
status
string
Optional
event
array of object (Event)
Optional
Array of Event
Response
200
Successfully retrieved the processed events report.
EventProcessReports
rows
array of object (EventProcessReportObject)
Optional
Array of EventProcessReportObject
page
object (Page)
Optional
Page
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/webhook/v1.0/company/{company_id}/reports/event_processed
Loading...
Response
Loading...
GET

List event configurations

Retrieve all configurations for event handling.
Parameters
No Parameters
Response
200
Successfully received ping for the provided webhook url.
EventConfigResponse
event_configs
array of object (EventConfig)
Optional
Array of EventConfig
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/webhook/v1.0/company/{company_id}/events
Loading...
Response
Loading...
POST

Register subscriber to event

Add a subscriber to receive events of a specific type.
Parameters
body
object (SubscriberConfig)
SubscriberConfig
id
integer
| int32
Optional
name
string
Optional
webhook_url
string
Optional
association
object (Association)
Optional
Association
custom_headers
object
Optional
status
object (SubscriberStatus)
Optional
Enum
email_id
string
Optional
auth_meta
object (AuthMeta)
Optional
AuthMeta
event_id
array of integer
Optional
Response
200
Success
SubscriberConfigResponse
id
integer
| int32
Optional
modified_by
string
Optional
name
string
Optional
webhook_url
string
Optional
association
object (Association)
Optional
Association
custom_headers
object
Optional
status
object (SubscriberStatus)
Optional
Enum
email_id
string
Optional
updated_on
string
Optional
created_on
string
Optional
type
string
Nullable
Optional
auth_meta
object (AuthMeta)
Optional
AuthMeta
event_id
array of integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/webhook/v1.0/company/{company_id}/subscriber/
Loading...
Response
Loading...
GET

List subscribers by company

Retrieve subscribers associated with a company.
Parameters
pageNo
integer
Optional
Page Number
pageSize
integer
| int32
Optional
Page Size
extensionId
string
Optional
extension_id
Response
200
Subscribers By Company ID.
SubscriberConfigList
items
array of object (SubscriberResponse)
Optional
Array of SubscriberResponse
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
1
pageSize:
10
extensionId:
"64affd97cbddb85348ca8f93"
Was this section helpful?
GET
/service/platform/webhook/v1.0/company/{company_id}/subscriber/
Loading...
Response
Loading...
PUT

Update a subscriber config

Modify and update subscriber configuration settings.
Parameters
body
object (SubscriberConfig)
SubscriberConfig
id
integer
| int32
Optional
name
string
Optional
webhook_url
string
Optional
association
object (Association)
Optional
Association
custom_headers
object
Optional
status
object (SubscriberStatus)
Optional
Enum
email_id
string
Optional
auth_meta
object (AuthMeta)
Optional
AuthMeta
event_id
array of integer
Optional
Response
200
Success
SubscriberConfigResponse
id
integer
| int32
Optional
modified_by
string
Optional
name
string
Optional
webhook_url
string
Optional
association
object (Association)
Optional
Association
custom_headers
object
Optional
status
object (SubscriberStatus)
Optional
Enum
email_id
string
Optional
updated_on
string
Optional
created_on
string
Optional
type
string
Nullable
Optional
auth_meta
object (AuthMeta)
Optional
AuthMeta
event_id
array of integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/webhook/v1.0/company/{company_id}/subscriber/
Loading...
Response
Loading...
GET

Get a subscriber

Retrieve a subscriber's details by their unique identifier.
Parameters
subscriberId
integer
subscriber id
Response
200
Success
SubscriberResponse
id
integer
| int32
Optional
modified_by
string
Optional
name
string
Optional
webhook_url
string
Optional
association
object (Association)
Optional
Association
custom_headers
object
Optional
status
object (SubscriberStatus)
Optional
Enum
email_id
string
Optional
updated_on
string
Optional
created_on
string
Optional
type
string
Nullable
Optional
auth_meta
object (AuthMeta)
Optional
AuthMeta
event_configs
array of object (EventConfig)
Optional
Array of EventConfig
Examples
Parameters
subscriberId:
1
Was this section helpful?
GET
/service/platform/webhook/v1.0/company/{company_id}/subscriber/{subscriber_id}
Loading...
Response
Loading...
GET

List subscribers by extension ID

Retrieve subscribers associated with a specific extension.
Parameters
pageNo
integer
Optional
Page Number
pageSize
integer
| int32
Optional
Page Size
extensionId
string
extension_id
Response
200
Success
SubscriberConfigList
items
array of object (SubscriberResponse)
Optional
Array of SubscriberResponse
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
1
pageSize:
10
extensionId:
"64affd97cbddb85348ca8f93"
Was this section helpful?
GET
/service/platform/webhook/v1.0/company/{company_id}/extension/{extension_id}/subscriber/
Loading...
Response
Loading...