Create a webhook

post

https://api.andesine.app/webhooks

Creates an enabled webhook unless enabled is false and returns the signing secret once. The caller must be able to read every resource type its events send, and restricted content when included.

Required API key permissions: webhooks. Write permissions also grant read access for the same resource.

Authentication

apiKeyhttp, bearer, Andesine API key

Use an Andesine API key as a Bearer token

oauthhttp, bearer, Andesine OAuth access token

Use an OAuth access token with andesine:api scope. Send x-workspace-id for workspace operations. Current user permissions apply.

Headers

x-workspace-idstring

Required for OAuth: ID of the workspace to access. API keys use their own workspace.

Request body *

application/json

Bodyobject

8 fields

name*string

url*string

enabledboolean

Default: true

eventTypes*array of WebhookEventName

schemaVersion*constant

Value: 1

collections*any of

Options

Any of

Option 1object

mode*constant

Value: "all"

Option 2object

mode*constant

Value: "selected"

roots*array of string

channels*any of

Options

Any of

Option 1object

mode*constant

Value: "all"

Option 2object

mode*constant

Value: "selected"

codes*array of string

restrictedContent*boolean

Include restricted collections, including ones restricted later

Responses

200OKapplication/json

Bodyobject

2 fields

endpoint*WebhookEndpoint

17 fields

name*string

url*string

enabled*boolean

eventTypes*array of WebhookEventName

schemaVersion*constant

Value: 1

collections*any of

Options

Any of

Option 1object

mode*constant

Value: "all"

Option 2object

mode*constant

Value: "selected"

roots*array of string

channels*any of

Options

Any of

Option 1object

mode*constant

Value: "all"

Option 2object

mode*constant

Value: "selected"

codes*array of string

restrictedContent*boolean

Include restricted collections, including ones restricted later

id*string

workspaceID*string

revision*number

destinationRevision*number

createdAt*string

updatedAt*string

disabledReason*any of

Options

Any of

Option 1string

One of: "manual", "failures"

Option 2null

health*object

7 fields

consecutiveFailures*number

firstFailureAt*any of

Options

Any of

Option 1string

Option 2null

lastFailureAt*any of

Options

Any of

Option 1string

Option 2null

lastFailureCategory*any of

Options

Any of

Option 1string

One of: "http_status", "timeout", "network", "destination_policy", "internal"

Option 2null

lastSuccessAt*any of

Options

Any of

Option 1string

Option 2null

pendingCount*number

failedCount*number

signing*object

2 fields

rotatedAt*string

previousSecretExpiresAt*any of

Options

Any of

Option 1string

Option 2null

secret*string

One-time signing secret. Never returned by configuration or history reads.

400Bad Requestapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "BAD_REQUEST"

status*constant

Value: 400

message*string

Default: "Bad Request"

dataValidationErrorData

2 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

issuesarray of ValidationIssue

3 fields

message*string

codestring

patharray of any of

Options

Any of

Option 1string

Option 2number

Option 3object

key*any of

Options

Any of

Option 1string

Option 2number

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

401Unauthorizedapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "UNAUTHORIZED"

status*constant

Value: 401

message*string

Default: "Unauthorized"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

403Forbiddenapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "FORBIDDEN"

status*constant

Value: 403

message*string

Default: "Forbidden"

dataForbiddenErrorData

4 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

missingPermissionsarray of string

requiredPlanconstant

Value: "pro"

actionstring

The requested action that was denied

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

404Not Foundapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "NOT_FOUND"

status*constant

Value: 404

message*string

Default: "Not Found"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

409Conflictapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "CONFLICT"

status*constant

Value: 409

message*string

Default: "Conflict"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

429Too Many Requestsapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "TOO_MANY_REQUESTS"

status*constant

Value: 429

message*string

Default: "Too Many Requests"

dataRateLimitErrorData

3 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

limitstring

The limit that was reached: a short-term rate limit, or a monthly API call, AI credit, or spending limit

One of: "rate", "api-calls", "ai-credits", "spending"

retryAfterSecondsnumber

Minimum delay before another attempt, in seconds. Also sent in Retry-After.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

500Internal Server Errorapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "INTERNAL_SERVER_ERROR"

status*constant

Value: 500

message*string

Default: "Internal Server Error"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

503Service Unavailableapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "SERVICE_UNAVAILABLE"

status*constant

Value: 503

message*string

Default: "Service Unavailable"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

Request

bash

curl --request POST \
  --url 'https://api.andesine.app/webhooks' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "string",
  "url": "string",
  "enabled": true,
  "eventTypes": [
    "entry.created"
  ],
  "schemaVersion": 1,
  "collections": {
    "mode": "all"
  },
  "channels": {
    "mode": "all"
  },
  "restrictedContent": true
}'

javascript

const response = await fetch("https://api.andesine.app/webhooks", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "string",
    "url": "string",
    "enabled": true,
    "eventTypes": [
      "entry.created"
    ],
    "schemaVersion": 1,
    "collections": {
      "mode": "all"
    },
    "channels": {
      "mode": "all"
    },
    "restrictedContent": true
  })
});

const data = await response.json();

python

import requests

response = requests.post(
    "https://api.andesine.app/webhooks",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "name": "string",
        "url": "string",
        "enabled": True,
        "eventTypes": [
            "entry.created",
        ],
        "schemaVersion": 1,
        "collections": {
            "mode": "all",
        },
        "channels": {
            "mode": "all",
        },
        "restrictedContent": True,
    },
)

print(response.json())

Response

json

{
  "endpoint": {
    "name": "string",
    "url": "string",
    "enabled": true,
    "eventTypes": [
      "entry.created"
    ],
    "schemaVersion": 1,
    "collections": {
      "mode": "all"
    },
    "channels": {
      "mode": "all"
    },
    "restrictedContent": true,
    "id": "string",
    "workspaceID": "string",
    "revision": 0,
    "destinationRevision": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "disabledReason": "manual",
    "health": {
      "consecutiveFailures": 0,
      "firstFailureAt": "string",
      "lastFailureAt": "string",
      "lastFailureCategory": "http_status",
      "lastSuccessAt": "string",
      "pendingCount": 0,
      "failedCount": 0
    },
    "signing": {
      "rotatedAt": "string",
      "previousSecretExpiresAt": "string"
    }
  },
  "secret": "string"
}

json

{
  "defined": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "Bad Request",
  "data": {
    "hints": [
      "string"
    ],
    "issues": [
      {
        "message": "string",
        "code": "string",
        "path": [
          "string"
        ]
      }
    ]
  }
}

json

{
  "defined": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "Unauthorized",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "Forbidden",
  "data": {
    "hints": [
      "string"
    ],
    "missingPermissions": [
      "string"
    ],
    "requiredPlan": "pro",
    "action": "string"
  }
}

json

{
  "defined": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "Not Found",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "CONFLICT",
  "status": 409,
  "message": "Conflict",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "TOO_MANY_REQUESTS",
  "status": 429,
  "message": "Too Many Requests",
  "data": {
    "hints": [
      "string"
    ],
    "limit": "rate",
    "retryAfterSeconds": 0
  }
}

json

{
  "defined": true,
  "code": "INTERNAL_SERVER_ERROR",
  "status": 500,
  "message": "Internal Server Error",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "SERVICE_UNAVAILABLE",
  "status": 503,
  "message": "Service Unavailable",
  "data": {
    "hints": [
      "string"
    ]
  }
}