Inbound HTTP (Webhook)

The Inbound HTTP Communication Channel can POST Transactions from Orderful to an HTTP endpoint that you specify. To see an example payload, refer to our API Reference.

Set up an Inbound HTTP Communication Channel

1. Go to your Communication Channels settings.
2. Click Create New and select HTTP in the "Create Inbound Channel" section.
3. Enter a descriptive Name for the Communication Channel, along with the URL of your HTTP endpoint.
4. (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>
5. 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. Go to your Communication Channels settings.
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.