Inbound HTTP (Webhook)

The Inbound HTTP Communication Channel can POST Transactions from Orderful to an HTTP endpoint that you specify.

The payload we send

For a Relationship that trades JSON through Mosaic, Orderful POSTs the following body. The transaction content is the same as what the Inbox returns, so push and pull can share your parsing logic — with one exception, the delivery object, noted below.

{
  "id": "019faa61-2fea-719b-a0f8-e6d42fbbc430",
  "integrationPayloadId": "019faa61-3053-76ef-a06c-4ff8ef1c9234",
  "transactionId": 993946486,
  "senderId": "ODFLRETAILTEST",
  "receiverId": "MosaicDemo",
  "stream": "test",
  "message": { "purpose": "original", "purchaseOrderNumber": "PO-V4TEST-006" },
  "ediTransactionType": "850_PURCHASE_ORDER",
  "simplifiedTransactionType": "PURCHASE_ORDER",
  "transaction": {
    "href": "https://{baseUrl}/transactions/019faa61-2fea-719b-a0f8-e6d42fbbc430",
    "acknowledgment": {
      "href": "https://{baseUrl}/transactions/019faa61-2fea-719b-a0f8-e6d42fbbc430/acknowledgment"
    }
  },
  "delivery": {
    "id": "b646771e-a068-4e32-832f-e96f895c5ec9",
    "href": "https://{baseUrl}/v3/deliveries/b646771e-a068-4e32-832f-e96f895c5ec9",
    "approve": { "href": "https://{baseUrl}/v3/deliveries/b646771e-a068-4e32-832f-e96f895c5ec9/approve" },
    "fail": { "href": "https://{baseUrl}/v3/deliveries/b646771e-a068-4e32-832f-e96f895c5ec9/fail" }
  }
}

Relationships that do not trade JSON through Mosaic receive a different body. Non-JSON formats such as XML, CSV, and PDF are pushed as a Transaction object with a downloadContentHref you fetch the content from.

Set up an Inbound HTTP Communication Channel

1. Sign in to your Orderful account:

2. From the left navigation menu, click on Communication Channels.
3. Click Create New and select HTTP in the "Create Inbound Channel" section.
4. Enter a descriptive Name for the Communication Channel, along with the URL of your HTTP endpoint.
5. (Optional) Authorization Type: If you'd like the communication to be encrypted with OAuth 2.0, select this option and fill out your OAuth 2.0 authorization information. Basic authorization is also supported. If you'd like to use it, simply include it as a part of the URL. For example <http://username:[email protected]/yourEndpoint>
6. Click Create.

📘

Custom Headers

Custom headers can be included with the Transaction that Orderful sends. To set these up please contact us at [email protected].

Test your Inbound HTTP Communication Channel

1. From the left navigation menu, click on Communication Channels.
2. Under "Inbound", select the Inbound HTTP that you would like to test. This will open a side panel.
3. Click on Send a test. This will bring up a modal where you can select an existing test file to send, or upload your own test file.
4. Click Send test.
5. Your test summary will appear in the side panel for your Communication Channel.

Sending your response to Orderful

Once your endpoint has received the transaction, you will have to respond to Orderful so that we can correctly update the status of the Transaction.

For example, if you respond with an HTTP 200, we will automatically mark the transaction as DELIVERED. If you respond with an HTTP 202, this means that you have received the transaction but are not finished processing it. In the case of an HTTP 202, you should use the Delivery API to mark a Delivery as Approved or Failed. For more information, see Transaction delivery statuses.