Create a project template

POST

/v1/templates

curl --request POST \
  --url https://api.hooks.events/v1/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "example", "name": "example", "description": "example", "provider": "example", "targetType": "example", "targetLabel": "example", "destinationName": "example", "testEventType": "example", "fields": [ { "key": "example", "label": "example", "type": "text", "required": true, "secret": true, "sourceSecret": true, "placeholder": "example", "help": "example" } ], "filters": { "additionalProperty": "example" }, "config": { "additionalProperty": "example" }, "urlTemplate": "example", "bodyTemplate": "example", "auth": { "additionalProperty": "example" }, "headers": { "additionalProperty": "example" }, "setup": [ "example" ] }'

• Production

Requires the endpoints:write scope.

Authorizations

• apiKey
• sessionCookie

Request Body^required

Media typeapplication/json

object

id

required

string

/^[a-z0-9]+(?:-[a-z0-9]+)*$/

name

required

string

>= 1 characters <= 120 characters

description

required

string

>= 1 characters <= 400 characters

provider

required

string

>= 1 characters

targetType

required

string

>= 1 characters

targetLabel

required

string

>= 1 characters <= 80 characters

destinationName

required

string

>= 1 characters <= 60 characters

testEventType

required

string

>= 1 characters

fields

required

Array<object>

>= 1 items <= 10 items

object

key

required

string

/^[a-z][a-zA-Z0-9]*$/

label

required

string

>= 1 characters <= 120 characters

type

required

string

Allowed values: text url password

required

required

boolean

secret

boolean

sourceSecret

boolean

placeholder

string

<= 300 characters

help

string

<= 500 characters

filters

object

key

additional properties

config

required

object

key

additional properties

urlTemplate

required

string

>= 1 characters

bodyTemplate

string

>= 1 characters <= 4000 characters

auth

object

key

additional properties

headers

object

key

additional properties

string

<= 4000 characters

setup

required

Array<string>

>= 1 items <= 8 items

Responses

201

Success

Media typeapplication/json

Source→target template

object

key

additional properties

Example ^generated

{
  "additionalProperty": "example"
}

400

Validation error

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

401

Missing or invalid credentials

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

403

The credential lacks the required scope, or the workspace is not writable

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

429

Rate limited

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

Headers

X-RateLimit-Limit

integer

Requests allowed per window

X-RateLimit-Remaining

integer

X-RateLimit-Reset

integer

Seconds until the window resets