Skip to main content
Kinetic Community

Webhooks

A webhook is a user-defined HTTP callback to a third-party application that is fired when some predetermined action occurs. Data that corresponds to the action, such as a form being submmitted, will be sent to the webhook URL as an HTTP Post action.

Operation List

GET /webhooks Retrieve Space Webhooks
POST /webhooks Create Space Webhook
GET /webhooks/{name} Retrieve Space Webhook
PUT /webhooks/{name} Update Space Webhook
DELETE /webhooks/{name} Delete Space Webhook
GET /kapps/{kappSlug}/webhooks Retrieve Kapp Webhooks
POST /kapps/{kappSlug}/webhooks Create Kapp Webhook
GET /kapps/{kappSlug}/webhooks/{name} Retrieve Kapp Webhook
PUT /kapps/{kappSlug}/webhooks/{name} Update Kapp Webhook
DELETE /kapps/{kappSlug}/webhooks/{name} Delete Kapp Webhook

Resource Schema

Available Includes

  • details
  • kapp
  • space

Operations

Retrieve Space Webhooks

GET /webhooks

Returns information about all Webhooks for the specified Space.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "webhooks": [
    {
      "event": "Complete",
      "filter": "true",
      "name": "Foo",
      "type": "Submission",
      "url": "http://my.server.com/api"
    }
  ]
}

Create Space Webhook

POST /webhooks

Creates a new webhook for the Space.

The user must have Space management privileges to perform this action.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "event": "Complete",
  "filter": "true",
  "name": "Foo",
  "type": "Submission",
  "url": "http://my.server.com/api"
}

Response

Body
{
  "webhook": {
    "event": "Complete",
    "filter": "true",
    "name": "Foo",
    "type": "Submission",
    "url": "http://my.server.com/api"
  }
}

Retrieve Space Webhook

GET /webhooks/{name}

Retrieves the Space Webhook identified by the {name} parameter.

Request

Path Parameters
name

The name of the webhook to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "webhook": {
    "event": "Complete",
    "filter": "true",
    "name": "Foo",
    "type": "Submission",
    "url": "http://my.server.com/api"
  }
}

Update Space Webhook

PUT /webhooks/{name}

Updates the Webhook specified by the {name} parameter with the property values sent in the request body.

NOTE All properties in the request body are optional, and only the properties supplied will be updated.

The user must have Space management privileges to perform this action.

Request

Path Parameters
name

The name of the webhook to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "event": "Complete",
  "filter": "true",
  "name": "Foo",
  "type": "Submission",
  "url": "http://my.server.com/api"
}

Response

Body
{
  "webhook": {
    "event": "Complete",
    "filter": "true",
    "name": "Foo",
    "type": "Submission",
    "url": "http://my.server.com/api"
  }
}

Delete Space Webhook

DELETE /webhooks/{name}

Deletes the Webhook specified by the {name} parameter.

The user must have Space management privileges to perform this action.

Request

Path Parameters
name

The name of the webhook to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "webhook": {
    "event": "Complete",
    "filter": "true",
    "name": "Foo",
    "type": "Submission",
    "url": "http://my.server.com/api"
  }
}

Retrieve Kapp Webhooks

GET /kapps/{kappSlug}/webhooks

Returns information about all Webhooks for the specified Kapp.

Request

Path Parameters
kappSlug

The slug of the kapp that the webhook belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "webhooks": [
    {
      "event": "Complete",
      "filter": "true",
      "name": "Foo",
      "type": "Submission",
      "url": "http://my.server.com/api"
    }
  ]
}

Create Kapp Webhook

POST /kapps/{kappSlug}/webhooks

Creates a new webhook for the Kapp.

The user must have Kapp management privileges to perform this action.

Request

Path Parameters
kappSlug

The slug of the kapp that the webhook belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "event": "Complete",
  "filter": "true",
  "name": "Foo",
  "type": "Submission",
  "url": "http://my.server.com/api"
}

Response

Body
{
  "webhook": {
    "event": "Complete",
    "filter": "true",
    "name": "Foo",
    "type": "Submission",
    "url": "http://my.server.com/api"
  }
}

Retrieve Kapp Webhook

GET /kapps/{kappSlug}/webhooks/{name}

Retrieves the Webhook identified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the kapp that the webhook belongs to.

name

The name of the webhook to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "webhook": {
    "event": "Complete",
    "filter": "true",
    "name": "Foo",
    "type": "Submission",
    "url": "http://my.server.com/api"
  }
}

Update Kapp Webhook

PUT /kapps/{kappSlug}/webhooks/{name}

Updates the Webhook specified by the {name} parameter with the property values sent in the request body.

NOTE All properties in the request body are optional, and only the properties supplied will be updated.

The user must have Kapp management privileges to perform this action.

Request

Path Parameters
kappSlug

The slug of the kapp that the webhook belongs to.

name

The name of the webhook to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "event": "Complete",
  "filter": "true",
  "name": "Foo",
  "type": "Submission",
  "url": "http://my.server.com/api"
}

Response

Body
{
  "webhook": {
    "event": "Complete",
    "filter": "true",
    "name": "Foo",
    "type": "Submission",
    "url": "http://my.server.com/api"
  }
}

Delete Kapp Webhook

DELETE /kapps/{kappSlug}/webhooks/{name}

Deletes the Webhook specified by the {name} parameter.

The user must have Kapp management privileges to perform this action.

Request

Path Parameters
kappSlug

The slug of the kapp that the webhook belongs to.

name

The name of the webhook to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "webhook": {
    "event": "Complete",
    "filter": "true",
    "name": "Foo",
    "type": "Submission",
    "url": "http://my.server.com/api"
  }
}

 

Related