v1

latestSwagger 2.02026-07-13302640.0 KB
Inputs

Create a New Input

Create one or more inputs for the bucket to get unique public endpoints.

post/v1/buckets/{bucketID}/inputs

Request body

idstring
created_atinteger
updated_atinteger
namestring
function_idstring

ID of the function that will be executed for this input

headersHeaders

A hashmap of header keys and a list of values for each string, Go equivalent map[string][]string

status_codeinteger

Response status code to return when this input receives a webhook

bodystring

Response body to return when this input receives a webhook

response_from_outputstring

Output ID to specify a single output for response or set it to 'anyOutput' to return response from any output. Output should respond within 10 seconds

custom_domainstring

Specify any custom domain from your Reserved Domains, such as example.hooks.webhookrelay.com or hooks.example.com (if used with your own top level domain name, create a CNAME pointing at hooks.webhookrelay.com)

path_prefixstring

When used with custom domains, path_prefix can host multiple input endpoints on a single domain, such as hooks.example.com/github -> Jenkins CI, hooks.example.com/gitlab -> Spinnaker

descriptionstring

Example request

{
  "headers": {
    "Content-Type": [
      "JSON"
    ],
    "Foo": [
      "Bar"
    ]
  }
}

Response

Created

idstring
created_atinteger
updated_atinteger
namestring
function_idstring

ID of the function that will be executed for this input

headersHeaders

A hashmap of header keys and a list of values for each string, Go equivalent map[string][]string

status_codeinteger

Response status code to return when this input receives a webhook

bodystring

Response body to return when this input receives a webhook

response_from_outputstring

Output ID to specify a single output for response or set it to 'anyOutput' to return response from any output. Output should respond within 10 seconds

custom_domainstring

Specify any custom domain from your Reserved Domains, such as example.hooks.webhookrelay.com or hooks.example.com (if used with your own top level domain name, create a CNAME pointing at hooks.webhookrelay.com)

path_prefixstring

When used with custom domains, path_prefix can host multiple input endpoints on a single domain, such as hooks.example.com/github -> Jenkins CI, hooks.example.com/gitlab -> Spinnaker

descriptionstring

Example response

{
  "headers": {
    "Content-Type": [
      "JSON"
    ],
    "Foo": [
      "Bar"
    ]
  }
}