Admin APIs

Subscribe to a Hook Event

POST /hooks/subscriptions
Api key auth

Subscribe to Events by creating a REST Hook Subscription

application/json

Body

  • subscription object
    Hide subscription attributes Show subscription attributes object
    • event_type Required

      A list of events that can be subscribed to using REST Hooks.

      • order_created - An order has been created
      • order_confirmed - An order has been confirmed
      • order_cancelled - An order has been cancelled
      • order_shipped - An order has been shipped

      Values are order_created, order_confirmed, order_cancelled, or order_shipped.

    • target_url Required
    • target string

      A user friendly name for the target

Responses

  • 201 application/json

    Hook Subscribed Successfully

    Hide response attributes Show response attributes object
    • id string(guid)

      System generated unique identifier. Don't include this in POST request body.

    • event_type string

      A list of events that can be subscribed to using REST Hooks.

      • order_created - An order has been created
      • order_confirmed - An order has been confirmed
      • order_cancelled - An order has been cancelled
      • order_shipped - An order has been shipped

      Values are order_created, order_confirmed, order_cancelled, or order_shipped.

    • target_url string(uri)
    • target string

      A user friendly name for the target
  • 422

    Invalid Req

POST /hooks/subscriptions 
curl \
 --request POST 'https://stg.getfoundation.com/api/external/v1/hooks/subscriptions' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"subscription":{"event_type":"order_created","target_url":"https://app.getfoundation.com/api/external/v1/hooks/order_created","target":"Workato Workflow"}}'
Request examples 
{
  "subscription": {
    "event_type": "order_created",
    "target_url": "https://app.getfoundation.com/api/external/v1/hooks/order_created",
    "target": "Workato Workflow"
  }
}
Response examples (201) 
{
  "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
  "event_type": "order_created",
  "target_url": "https://app.getfoundation.com/api/external/v1/hooks/order_created",
  "target": "Workato Workflow"
}