Skip to content
Hooks Docs

Create an API key

POST
/v1/api-keys
curl --request POST \
  --url https://api.hooks.events/v1/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "scopes": [ "endpoints:read" ], "expiresAt": "2026-04-15T12:00:00Z" }'

The plaintext key is returned once, in key.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 100 characters
scopes
required
Array<string>
>= 1 items
Allowed values: endpoints:read endpoints:write deliveries:read deliveries:retry history:purge metrics:read alerts:read alerts:write
expiresAt
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/

Responses

Section titled “Responses”

201

Section titled “201”

Success

Media typeapplication/json
object
data
required
object
id
required

Resource id

string
name
required
string
prefix
required
string
scopes
required
Array<string>
lastUsedAt
required
Any of:

ISO-8601 timestamp

string
expiresAt
required
Any of:

ISO-8601 timestamp

string
createdAt
required

ISO-8601 timestamp

string
key
additional properties
key
additional properties

Example generated

{
  "data": {
    "id": "example",
    "name": "example",
    "prefix": "example",
    "scopes": [
      "example"
    ],
    "lastUsedAt": "example",
    "expiresAt": "example",
    "createdAt": "example"
  }
}

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