IBM API Hub
IBM watsonx Orchestrate API

By IBM watsonx Orchestrate

IBM watsonx Orchestrate provides a set of APIs to boost your experience using the features from the product.


API reference

Create an artifact of category webhook

POST

/catalog/artifacts

Creates a new artifact of type webhook. Optionally, it can be explicitly published using the 'state' query parameter.

Request URL
{api_endpoint}/v1/orchestrate/catalog/artifacts?state=REPLACE_THIS_VALUE
Security
apiKey
IAM-API_KEY
required in header

Authentication for IBM watsonx Orchestrate on IBM Cloud.

Parameters
Name
Description
  • state
    string
    (query)

    If provided with 'PUBLISH', explicitly publishes the artifact.

    Allowed values : [PUBLISH]
  • Content-type
    string
    (header)
    application/json
  • Accept
    string
    (header)
    application/json
  • Request body
    Responses
    • 201

      Artifact created successfully

    Code snippet
      1curl --request POST \
      2  --url 'REPLACE_API_ENDPOINT_VARIABLE/v1/orchestrate/catalog/artifacts?state=REPLACE_THIS_VALUE' \
      3  --header 'IAM-API_KEY: REPLACE_THIS_VALUE' \
      4  --header 'accept: application/json' \
      5  --header 'content-type: application/json' \
      6  --data REPLACE_REQUEST_BODY
      

        Example response

          1{
          2  "id": "5fcbe461-ec83-5975-bc01-6a490e8fe9a0",
          3  "name": "Ann Mathis",
          4  "description": "Ade lotdozik lev aza folmovhum jeaga ahse ij sov ja em ulo ketri pah we.",
          5  "icon": "doloujike",
          6  "visibility": false,
          7  "state": "PUBLISH",
          8  "metadata": {
          9    "id": 3391243249778688
          10  },
          11  "config": {
          12    "id": 5093794313666560
          13  },
          14  "created_by": "emzojupivaomoe",
          15  "update_by": "10/22/2125",
          16  "created_at": "2001-09-09T02:20:14.806Z",
          17  "updated_at": "2006-02-28T17:56:09.392Z",
          18  "tenant_id": "8e708823-8938-5c31-b85a-84734ef30e5d"
          19}