Page cover

Yofi API Webhooks

Sending data to Yofi

post

The Yofi Webhook API allows our partners to send real-time data about orders, customers, returns, and refunds directly to Yofi.
This data enables advanced analysis and provides valuable insights into your business.
The webhook uses a secure, signature-based authentication mechanism to ensure data integrity and origin verification.

Partner can request on this API endpoint to send data to Yofi, including events of order/fulfillment/claim/return.

The request body contains the raw object of an order/fulfillment/claim/return, varying based on the x-event-type header.

Check the following examples to see request body for each data type. For example,
for order event type, payload should be an raw order object,
while for fulfillment event, payload should be an raw fulfillment object.

Notes:

  • The payload data should be a complete data object with mandatory fields
    • for example the created_at field is required in customer nested object for order event.
  • Historical data older than 30days will be skipped for processing.
  • For order events, orders/create event is skipped for processing by Yofi backend, as it's duplicate event with orders/paid

Sample python code to generate X-Signature-SHA256


import hashlib
import hmac
import base64
payload_body = """{order_fields:"...."}"""
partner_secret = "secret_key_to_provided_by_yofi"
digest = hmac.new(partner_secret.encode('utf-8'),
                  msg=payload_body.encode('utf-8'),
                  digestmod=hashlib.sha256).digest()
sign_sha256 = base64.b64encode(digest).decode('utf-8')
print(sign_sha256)
Header parameters
X-Signature-SHA256stringRequired

Base64 encoded HMAC SHA256 signature of the request payload, used for verifying the request authenticity. Use the secret key(provided with Yofi) to generate.

Example: QMe+tAtZLBB6S/7Fyil6UpBfIiHb7Kem8kBily20i9Q=
x-partner-idstringRequired

Identifier for the partner receiving the webhook.

Example: demo
x-merchant-idstringRequired

Identifier for the specific merchant of the event.

Example: yofi_partner_demo.myshopify.com
x-event-typestringRequired

Type of the event being sent, request payload body should be the data object according to this type, like order, fulfillment, claim or return.

For order

  • orders/paid
  • orders/cancelled
  • orders/updated
  • orders/edited
  • orders/create
  • orders/delete
  • orders/fulfilled
  • orders/partially_fulfilled

For customers

  • customer/create
  • customer/update

For events

  • event/create

For fulfillment:

  • fulfillments/create
  • fulfillments/update

For claims

  • claims/create
  • claims/update

For returns

  • returns/create
  • returns/update
Example: xxx_input_your_event_type_here
Body
idintegerRequired

The source id of the resource, based on the data of source platform like Shopify

created_atstringRequired

The source created_at of the source resource object, based on data of source platform like Shopify.

partner_resource_idstringOptional

Optional: the resource id in partner database

partner_resource_platformstringOptional

Optional: the platform that the resource come from, like shopify, woocommerce, magento, bigcommerce, api

...other_field_of_the_data_object...stringOptional

Other fields of order/fulfillment/claim/return, according to event type, refer to shopify api docs

Responses
200

Successfully Received!

text/plain
post
/webhook

PreviousData TransferNextCloud Storage Data Transfer

Last updated

Was this helpful?