Omniful, Inc.

Omniful, Inc. Webhook API

The Webhook API from Omniful, Inc. — 1 operation(s) for webhook.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.omniful.tech
📖
APIReference
https://docs.omniful.tech
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/authentication/omniful-inc-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/openapi/omniful-inc-webhook-api-openapi.yml

Other Resources

🔗
Postman
https://docs.omniful.tech
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/asyncapi/omniful-inc-webhooks.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/conventions/omniful-inc-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/errors/omniful-inc-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/omniful-inc/refs/heads/main/data-model/omniful-inc-data-model.yml

OpenAPI Specification

omniful-inc-webhook-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Omniful Integration APIs Background Jobs Webhook API
  version: v1
  description: Omniful unified supply chain and fulfillment platform integration APIs (Order Management, Warehouse/Inventory, Returns, Purchase Orders, Shipment/TMS, Webhooks). Derived faithfully from the provider-published Postman collection at docs.omniful.tech; paths, methods, parameters, and request examples are as published, response schemas are not enumerated in the source.
  contact:
    url: https://docs.omniful.tech
servers:
- url: https://prodapi.omniful.com
security:
- bearerAuth: []
tags:
- name: Webhook
paths:
  /sales-channel/public/v1/webhooks:
    put:
      summary: Register Webhook
      operationId: putRegisterWebhook
      tags:
      - Webhook
      requestBody:
        content:
          application/json:
            example:
            - topic: shipment_webhook
              webhook_url: https://webhook.site/181a3c04-263d-4032-a8b0-d778ef5698fc
              is_enable: true
              custom_headers:
              - key: X-AUTH-TOKEN
                value: New_token
      responses:
        '200':
          description: Successful response
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer