Create Webhook

This API allows the developer to create a new webhook subscription.

Swagger

			
swagger: '2.0'
info:
  x-ibm-name: orders
  title: Orders
  version: 1.0.0
schemes:
  - https
host: $(catalog.host)
basePath: /v1
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  oauth2:
    type: oauth2
    description: ''
    flow: accessCode
    authorizationUrl: 'https://<.........................>/fsc/oauth2/authorize'
    scopes:
      Fulfillment_Returns: ''
    tokenUrl: 'https://<.........................>/fsc/oauth2/token'
  Client_Secret:
    type: apiKey
    description: Enter Client Secret
    in: header
    name: X-IBM-Client-Secret
  Client_Id:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
    description: Enter Client ID
security:
  - Client_Secret: []
    Client_Id: []
    oauth2:
      - Fulfillment_Returns
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /services/webhook:
    post:
      responses:
        200:
          description: 200 OK
      parameters:
      - name: create_order_json_body
        required: true
        in: body
        schema:
          type: json
        description: ''
      - name: AccessToken
        type: string
        required: true
        in: header
        description: Enter Access Token, it is required header
      	summary: Create Webhook
      	description: This API allows the developer to create a new webhook subscription. 
 
   

         

{    
    "eventName": "Order_Shipped",
    "url": "https://yourcompany.com/webhook/callbackURL",
    "secret":"top_secret"
}

 
       

         
{
     "requestIdentifier": "234234234234234",
     "transactionDate": "2018-09-20T15:12:54-05:00",
     "status": "success",
     "webhooks": [
      {
         "webhookId": "1111"
       }
]
}

      

      
{
  "status": "error",
  "errors": [
    {
      "code": "ERR-SYS-0001",
      "description": "Your request cannot be processed due to a system error."
    }
  ]
}