Eventing (Core)

Endpoints to create, update and read subscriptions.

List subscriptions

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

Responses

200

All subscriptions.

application/json

Subscriptions

totalintegerOptional

Total number of found entities for this query

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

get

/api/subscriptions

HTTPcURLJavaScriptPython

GET /api/subscriptions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "subscriptions": [
    {
      "contexts": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "event": "text",
      "name": "text",
      "target": {
        "callbackUrl": "text",
        "headers": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "type": "WEBHOOK"
      }
    }
  ],
  "total": 42
}

Create subscription

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Add new Subscription. Please note: Currently it is only possible to add max. five subscriptions per event.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

SubscriptionForCreation

callbackUrlstringOptionalDeprecated

This part of the API is deprecated. For details please check the api-release-life-cycle documentation.

Deprecated: Use new 'target' object instead.

eventstringRequired

Name of the event in the fulfillmenttools platform.

namestringRequired

Name of the event, this is freely selectable.

targetany ofOptional

or

or

Responses

201

Subscription is successfully created.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/subscriptions

HTTPcURLJavaScriptPython

POST /api/subscriptions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "contexts": [
    {
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "event": "text",
  "name": "text",
  "target": {
    "callbackUrl": "text",
    "headers": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "type": "WEBHOOK"
  }
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "id": "text",
  "contexts": [
    {
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "event": "text",
  "name": "text",
  "target": {
    "callbackUrl": "text",
    "headers": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "type": "WEBHOOK"
  }
}

Delete subscription

delete

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

subscriptionIdstringRequired

ID of the subscription you want to delete

Responses

200

Subscription is successfully deleted.

application/json

Subscription

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

delete

/api/subscriptions/{subscriptionId}

HTTPcURLJavaScriptPython

DELETE /api/subscriptions/{subscriptionId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2020-02-03T08:45:51.525Z",
  "id": "text",
  "contexts": [
    {
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "event": "text",
  "name": "text",
  "target": {
    "callbackUrl": "text",
    "headers": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "type": "WEBHOOK"
  }
}

List supported events

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

All supported events.

application/json

SupportedEvents

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

get

/api/supportedevents

HTTPcURLJavaScriptPython

GET /api/supportedevents HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "supportedEvents": [
    {
      "description": "text",
      "event": "text"
    }
  ]
}