Skip to content
Browse documentation

OpenAPI operations

Create an application

POST
/v1/applications
curl --request POST \
  --url https://api.hooks.events/v1/applications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "uid": "example", "brandColor": "example", "customDomain": "example" }'

Each application is one end customer and owns a hidden endpoint plus its own Standard Webhooks signing key. uid is a customer-side id, unique per workspace.

Requires the endpoints:write scope.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 120 characters
uid
string
>= 1 characters <= 64 characters /^[A-Za-z0-9._:-]+$/
brandColor
string
/^#[0-9a-f]{6}$/
customDomain
Any of:
string
<= 253 characters /^(?=.{4,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$/

Example generated

{
  "name": "example",
  "uid": "example",
  "brandColor": "example",
  "customDomain": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Success

Media typeapplication/json

Tenant application (one end customer)

object
id
required

Resource id

string
uid
required

Customer-side identifier, unique per workspace

string | null
name
required
string
brandColor
required

Portal accent color

string
customDomain
required

Customer hostname that fronts the portal

string | null
status
required
string
Allowed values: active archived
endpointId
required

Backing endpoint that receives the application’s messages

string
ingestUrl
required

Public URL of the backing endpoint

string
createdAt
required

ISO-8601 timestamp

string
updatedAt
required

ISO-8601 timestamp

string
key
additional properties

Example 

{
  "status": "active"
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “Headers”
X-RateLimit-Limit
integer

Requests allowed per window

X-RateLimit-Remaining
integer
X-RateLimit-Reset
integer

Seconds until the window resets