Webhooks

List of Webhook events

Retrieve webhook types

Fetches a list of available webhook types based on search criteria.

Request

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field by which to filter.
searchCriteria[filterGroups][0][filters][0][value]	string Value for the field.
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type for the filter.
searchCriteria[sortOrders][0][field]	string Field by which to sort results.
searchCriteria[sortOrders][0][direction]	string Direction of sort (ASC or DESC).
searchCriteria[pageSize]	integer Number of results to return per page.
searchCriteria[currentPage]	integer The page number to retrieve.

Responses

200

A JSON object containing the webhook types

401

Unauthorized

get/rest/V1/omnyfy/webhook_types

Response samples

application/json

{"items": [{"id": 0,
"type": "string"
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

Retrieve webhooks

Fetches a list of webhooks based on search criteria.

Request

path Parameters

store-id

required

string

The ID of the store for which to retrieve webhooks.

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field by which to filter.
searchCriteria[filterGroups][0][filters][0][value]	string Value for the field.
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type for the filter.
searchCriteria[sortOrders][0][field]	string Field by which to sort results.
searchCriteria[sortOrders][0][direction]	string Direction of sort (ASC or DESC).
searchCriteria[pageSize]	integer Number of results to return per page.
searchCriteria[currentPage]	integer The page number to retrieve.

Responses

200

An array of webhooks

401

Unauthorized

get/rest/V1/omnyfy/{store-id}/webhooks

Response samples

application/json

{"items": [{"status": 1,
"store_id": 1,
"webhook_type_id": 12,
"method": "POST",
"endpoint_url": "http://52.64.77.109/v2/middleware/orderCallback?omnyfyStoreId=33",
"content_type": "application/json",
"id": 1,
"created_at": "2024-03-13 17:17:57",
"updated_at": "2024-03-21 19:55:15"
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

Create a webhook

Sends data to create or update a webhook configuration.

Request

Request Body schema: application/json
required

status	integer The status of the webhook.
store_id	integer The store identifier associated with the webhook.
webhook_type_id	integer The webhook type identifier.
method	string The HTTP method used by the webhook.
endpoint_url	string <uri> The endpoint URL to which the webhook sends data.
content_type	string The content type of the data sent to the endpoint.

Responses

200

Webhook configuration response

400

Unexpected error

401

Unauthorized

post/rest/V1/omnyfy/webhook

Request samples

Payload

application/json

{"status": 1,
"store_id": 1,
"webhook_type_id": 12,
"method": "POST",
"endpoint_url": "http://52.64.77.109/v2/middleware/orderCallback?omnyfyStoreId=33",
"content_type": "application/json"
}

Response samples

application/json

{"status": 1,
"store_id": 1,
"webhook_type_id": 12,
"method": "POST",
"endpoint_url": "http://52.64.77.109/v2/middleware/orderCallback?omnyfyStoreId=33",
"content_type": "application/json",
"id": 1,
"created_at": "2024-03-13 17:17:57",
"updated_at": "2024-03-21 19:55:15"
}

Update an existing webhook

Updates an existing webhook configuration based on the provided ID.

Request

Request Body schema: application/json
required

status	integer The status of the webhook.
store_id	integer The store identifier associated with the webhook.
webhook_type_id	integer The webhook type identifier.
method	string The HTTP method used by the webhook.
endpoint_url	string <uri> The endpoint URL to which the webhook sends data.
content_type	string The content type of the data sent to the endpoint.
id	integer The unique identifier for the webhook.

Responses

200

Webhook configuration response

400

Unexpected error

401

Unauthorized

put/rest/V1/omnyfy/webhook

Request samples

Payload

application/json

{"status": 1,
"store_id": 1,
"webhook_type_id": 12,
"method": "POST",
"endpoint_url": "http://52.64.77.109/v2/middleware/orderCallback?omnyfyStoreId=33",
"content_type": "application/json",
"id": 1
}

Response samples

application/json

{"status": 1,
"store_id": 1,
"webhook_type_id": 12,
"method": "POST",
"endpoint_url": "http://52.64.77.109/v2/middleware/orderCallback?omnyfyStoreId=33",
"content_type": "application/json",
"id": 1,
"created_at": "2024-03-13 17:17:57",
"updated_at": "2024-03-21 19:55:15"
}

Delete a webhook

Deletes a specific webhook given its unique identifier.

Request

path Parameters

webhookId

required

integer

The unique identifier of the webhook to be deleted.

Responses

200

Returns true if the webhook was successfully deleted.

400

Unexpected error

401

Unauthorized

delete/rest/V1/omnyfy/webhook/{webhookId}

Response samples

application/json

true

vendor.approved

Request

Request Body schema: application/json

Omnyfy webhook event for vendor.approved

event_id	string A unique identifier for the event.
event_type	string Type of the event.
created_utc	integer The Unix timestamp representing the creation time of the event.
	object (event-vendor-approved-data)

Responses

200

Return a 200 status to indicate that the data was received successfully

post/vendor.approved

Request samples

Payload

application/json

{"event_id": "5f2b18d6c28eca001334c576",
"event_type": "vendor.approved",
"created_utc": 1614556800,
"data": {"id": "5",
"name": "Microtech",
"slug": "microtech",
"rating": {"star_count": "4",
"review_count": "150"
},
"address": {"street": "3704 Marigold Lane",
"city": "Miami",
"state": "Florida",
"country": "US",
"postcode": "33179"
},
"image_url": false,
"background_image_url": false,
"about": {"type": "text",
"content": "<p>Sample Description</p>"
},
"attributes": [{"type": "multiselect",
"title": "Industry",
"value": ["string"
]
}
]
}
}

order.updated

Request

Request Body schema: application/json

Omnyfy webhook event for order.updated

event_id	string
event_type	string
	object (event-order-updated-data)

Responses

200

Return a 200 status to indicate that the data was received successfully

post/order.updated

Request samples

Payload

application/json

{"event_id": "string",
"event_type": "string",
"data": {"entity_id": 0,
"object": "string",
"timestamp": "string",
"currency": "string",
"total": 0,
"discount": 0,
"status": "string",
"payment_status": "string",
"fulfilment_status": "string",
"items": [{"sku": "string",
"qty": 0,
"vendor": {"object": "string",
"entity_id": 0,
"name": "string"
}
}
],
"customer": {"entity_id": 0,
"object": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string"
},
"shipping_address": {"entity_id": 0,
"city": "string",
"street": ["string"
],
"country_code": "string",
"postcode": "string",
"first_name": "string",
"last_name": "string",
"telephone": "string"
}
}
}

cart.updated

Request

Request Body schema: application/json

Omnyfy webhook event for cart.updated

event_id	string
event_type	string
	object

Responses

200

Return a 200 status to indicate that the data was received successfully

post/cart.updated

Request samples

Payload

application/json

{"event_id": "string",
"event_type": "string",
"data": {"entity_id": 0,
"object": "string",
"items": [{"entity_id": 0,
"sku": "string",
"qty": 0,
"vendor": {"object": "string",
"entity_id": 0,
"name": "string"
}
}
],
"customer": {"entity_id": 0,
"object": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string"
}
}
}

product.updated

Request

Request Body schema: application/json

Omnyfy webhook event for product.updated

event_id	string
event_type	string
	object

Responses

200

Return a 200 status to indicate that the data was received successfully

post/product.updated

Request samples

Payload

application/json

{"event_id": "string",
"event_type": "string",
"data": {"product": {"id": 0,
"sku": "string",
"name": "string",
"attribute_set_id": 0,
"price": 0,
"status": 0,
"visibility": 0,
"type_id": "string",
"created_at": "string",
"updated_at": "string",
"weight": 0,
"extenstion_attributes": {"website_ids": [0
]
},
"product_links": "string",
"options": { },
"media_gallery_entries": ["string"
],
"tier_prices": [{"price": 0,
"customer_group_id": 0,
"qty": 0
}
],
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
}
}

shipment.updated

Request

Request Body schema: application/json

Omnyfy webhook event for shipment.updated

event_id	string
event_type	string
	object (event-shipment-updated-data)

Responses

200

Return a 200 status to indicate that the data was received successfully

post/shipment.updated

Request samples

Payload

application/json

{"event_id": "string",
"event_type": "string",
"data": {"shipment": {"billing_address_id": 0,
"created_at": "string",
"customer_id": 0,
"email_sent": true,
"entity_id": 0,
"increment_id": "string",
"order_id": 0,
"shipping_address_id": 0,
"store_id": 0,
"total_qty": 0,
"updated_at": "string",
"items": [{"name": "string",
"price": 0,
"product_id": 0,
"sku": "string",
"weight": 0,
"order_item_id": 0,
"qty": 0
}
],
"tracks": [{"track_number": "string",
"title": "string",
"carrier_code": "string"
}
],
"comments": ["string"
]
}
}
}

➔ Next to Vendor endpoints

Webhooks

Retrieve webhook types

query Parameters

Retrieve webhooks

path Parameters

query Parameters

Create a webhook

Request Body schema: application/jsonrequired

Update an existing webhook

Request Body schema: application/jsonrequired

Delete a webhook

path Parameters

vendor.approved

Request Body schema: application/json

order.updated

Request Body schema: application/json

cart.updated

Request Body schema: application/json

product.updated

Request Body schema: application/json

shipment.updated

Request Body schema: application/json

Request Body schema: application/json
required

Request Body schema: application/json
required