Manage webhooks

See all webhooks

To get a list of all webhooks in your workspace with their IDs, call the /workspaces/{workspace-id}/webhooks endpoint with your workspace ID as a path parameter.

Request

GET /workspaces/{workspace-id}/webhooks HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Response

See response example

{
  "data": [
    {
      "id": "1df1ebb0-78a4-55d9-b806-15d22e391bd3",
      "url": "https://my.sample.endpoint.com/",
      "name": "My alert for job and order statuses",
      "active": true,
      "events": ["job.status, order.status"],
      "createdAt": "2022-02-17T08:47:11.377149Z",
      "updatedAt": "2022-02-17T08:47:11.377149Z",
      "secret": "QWZTFnMEXhqZKNmu"
    },
    {
      "id": "3ca2cab0-87b0-66d5-a755-55c13e353ac4",
      "url": "https://my.sample.endpoint.com/",
      "name": "An old alert for job statuses",
      "active": false,
      "events": ["job.status"],
      "createdAt": "2021-02-17T08:47:11.377149Z",
      "updatedAt": "2021-02-17T08:47:11.377149Z",
      "secret": ""
    }
  ],
  "error": null
}

Parameter	Overview
`data.id`	string The webhook ID.
`data.url`	string The URL of the webhook.
`data.name`	string The name of the webhook.
`data.active`	boolean Whether this webhook is active.
`data.events`	array of strings A list of events that trigger the webhook.
`data.createdAt`	string The timestamp when the webhook was created.
`data.updatedAt`	string The timestamp when the webhook was last updated.
`data.secret`	string The secret used to generate webhook signatures.

See a particular webhook

To get information about one webhook, call the /workspaces/{workspace-id}/webhooks/{webhook-id} endpoint with your workspace ID and a specific webhook ID as path parameters.

Request

GET /workspaces/{workspace-id}/webhooks/{webhook-id} HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Response

See response example

{
  "data": {
    "id": "1df1ebb0-78a4-55d9-b806-15d22e391bd3",
    "url": "https://my.sample.endpoint.com/",
    "name": "My alert for job and order statuses",
    "active": true,
    "events": ["job.status, order.status"],
    "createdAt": "2022-02-17T08:47:11.377149Z",
    "updatedAt": "2022-02-17T08:47:11.377149Z",
    "secret": "QWZTFnMEXhqZKNmu"
  },
  "error": null
}

Parameter	Overview
`data.id`	string The webhook ID.
`data.url`	string The URL of the webhook.
`data.name`	string The name of the webhook.
`data.active`	boolean Whether this webhook is active.
`data.events`	array of strings A list of events that trigger the webhook.
`data.createdAt`	string The timestamp when the webhook was created.
`data.updatedAt`	string The timestamp when the webhook was last updated.
`data.secret`	string The secret used to generate webhook signatures.

Edit a webhook

To change parameters of a created webhook, call the /workspaces/{workspace-id}/webhooks/{webhook-id} endpoint with your workspace ID and a specific webhook ID as path parameters.

Request

PUT /workspaces/{workspace-id}/webhooks/{webhook-id} HTTP/1.1
Host: api.up42.com
Content-Type: application/json
Authorization: Bearer {token}

Parameter	Overview
`events`	array of strings / required A list of events that trigger the webhook.
`name`	string / required The name of the webhook.
`url`	string / required The URL of the webhook.
`secret`	string The secret used to generate webhook signatures.
`active`	boolean Whether this webhook should be active after creation. The default value is `false`.

See request example

{
  "events": ["job.status, order.status"],
  "name": "My updated alert for job and order statuses",
  "url": "https://my.sample.endpoint.com/",
  "secret": "QWZTFnMEXhqZKNmu",
  "active": true
}

Response

See response example

{
  "data": {
    "id": "1df1ebb0-78a4-55d9-b806-15d22e391bd3",
    "url": "https://my.sample.endpoint.com/",
    "name": "My updated alert for job and order statuses",
    "active": true,
    "events": ["job.status, order.status"],
    "createdAt": "2022-02-17T08:47:11.377149Z",
    "updatedAt": "2022-02-17T08:47:11.377149Z",
    "secret": "QWZTFnMEXhqZKNmu"
  },
  "error": null
}

Parameter	Overview
`data.id`	string The webhook ID.
`data.url`	string The URL of the webhook.
`data.name`	string The name of the webhook.
`data.active`	boolean Whether this webhook is active.
`data.events`	array of strings A list of events that trigger the webhook.
`data.createdAt`	string The timestamp when the webhook was created.
`data.updatedAt`	string The timestamp when the webhook was last updated.
`data.secret`	string The secret used to generate webhook signatures.

Delete a webhook

Request

To delete a webhook, call the /workspaces/{workspace-id}/webhooks/{webhook-id} endpoint with your workspace ID and a specific webhook ID as path parameters.

DELETE /workspaces/{workspace-id}/webhooks/{webhook-id} HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Response

If a webhook is deleted successfully, there will be no response body.