Guides

Supplier Update Request Data Model

Data Model

Overview

The "Supplier Update Request Status Changed" webhook is triggered whenever there is a request to edit a supplier that has been approved or rejected. This webhook ensures that your system is notified of the status of the update request, allowing for real-time updates and appropriate actions.

Your webhook endpoint will receive a POST request containing an event with a Code of 7 and Name of SUPPLIER_UPDATE_REQUEST_CHANGED. This event is particularly useful for tracking the changes you have made to the suppliers.


Request Model

The webhook payload consists of multiple nested objects containing essential recurring payment details.

Event Object

Input ParameterTypeDescription
Event.Codenumber7 - SUPPLIER_UPDATE_REQUEST_CHANGED
Event.NamestringSUPPLIER_UPDATE_REQUEST_CHANGED
Event.CountryIsoCodestringThe country of your account with MyFatoorah.
Event.CreationDatedatetimeThe timestamp when the event was created in ISO 8601 format.
Event.ReferencestringUnique reference ID for the webhook event.

Data Object

The Data Object contains multiple nested objects as follows.

Supplier Object

Input ParameterTypeDescription
Supplier.CodenumberThe code of the supplier in MyFatoorah system.
Supplier.NamestringThe supplier name in MyFatoorah system.
Supplier.MobiledatetimeThe mobile number of the supplier.
Supplier.EmailstringThe email of the supplier,
Supplier.StatusstringThe status of the supplier. (APPROVED - REJECTED)

RequestStatus Object

Input ParameterTypeDescription
RequestStatus.StatusstringThe status of the request. (APPROVED - REJECTED)
RequestStatus.CommentsstringThe comments entered by the concerned team for the request.
RequestStatus.ReferencestringThe date and time when the decision on the request was made, formatted in ISO 8601 UTC.

Sample Event

The sample JSON message is sent by MyFatoorah to your endpoint.

{
  "Event": {
    "Code": 7,
    "Name": "SUPPLIER_UPDATE_REQUEST_CHANGED",
    "CountryIsoCode": "SAU",
    "CreationDate": "2025-08-18T09:56:35.8500000Z",
    "Reference": "WH-10106895"
  },
  "Data": {
    "Supplier": {
      "Code": 236,
      "Name": "Bernita Bode",
      "Mobile": "6796176709",
      "Email": "[email protected]",
      "Status": "APPROVED"
    },
    "RequestStatus": {
      "Status": "APPROVED",
      "Comments": "Approve with comment",
      "ActionDate": "2025-08-18T09:56:35.8175777Z"
    }
  }
}

Webhook Signature

You will use the parameters mentioned below to generate the webhook signature for the SUPPLIER_UPDATE_REQUEST_CHANGED event.

Supplier.Code=236,RequestStatus.Status=APPROVED

This webhook allows real-time tracking of editing supplier requests, ensuring the supplier information is updated in your system.