Sign in
webhook

List project webhook policies.

This endpoint returns webhook policies of a project.

get/projects/{project_name_or_id}/webhook/policies

Path parameters

project_name_or_idstring required

The name or id of the project

Query parameters

sortstring

Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending order and field2 in descending order with "sort=field1,-field2"

qstring

Query string to query resources. Supported query patterns are "exact match(k=v)", "fuzzy match(k=v)", "range(k=[minmax])", "list with union releationship(k={v1 v2 v3})" and "list with intersetion relationship(k=(v1 v2 v3))". The value of range and list can be string(enclosed by " or '), integer or time(in format "2020-04-09 02:36:00"). All of these query patterns should be put in the query string "q=xxx" and splitted by ",". e.g. q=k1=v1,k2=v2,k3=[minmax]

pageinteger

The page number

page_sizeinteger

The size of per page

Headers

X-Request-Idstring

An unique ID for the request

X-Is-Resource-Nameboolean

The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.

Response

Success

idinteger

The webhook policy ID.

namestring

The name of webhook policy.

descriptionstring

The description of webhook policy.

project_idinteger

The project ID of webhook policy.

event_typesstring[]
creatorstring

The creator of the webhook policy.

creation_timestring date-time

The create time of the webhook policy.

update_timestring date-time

The update time of the webhook policy.

enabledboolean

Whether the webhook policy is enabled or not.

Example response

[
  {
    "targets": [
      {
        "payload_format": "CloudEvents"
      }
    ]
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.