Register a new webhook

POST 
/webhook

Register a new webhook

Request

application/json

Body

Webhook registration data

resource stringrequired

Possible values: [schema]

Resource to attach the webhook to

body string

The body for the webhook request, supporting variables.

headers string

Custom headers to include in the webhook request, such as authentication tokens.

eventType stringrequired

Possible values: [submission_approved]

Event type that triggers the webhook.

url urirequired

The URL to which the webhook will send event data.

resourceId stringrequired

Identifier of the resource to attach webhook to

Responses

201

Webhook successfully created

application/json

Schema

Schema

resource stringrequired

Possible values: [schema]

Resource to attach the webhook to

body string

The body for the webhook request, supporting variables.

headers string

Custom headers to include in the webhook request, such as authentication tokens.

createdAt date-time

Time representation of entity creation

eventType stringrequired

Possible values: [submission_approved]

Event type that triggers the webhook.

projectId string

Unique identifier of the project to which webhook is related

id string

Unique identifier of the webhook

url urirequired

The URL to which the webhook will send event data.

resourceId stringrequired

Identifier of the resource to attach webhook to

Example (from schema)

{
  "resource": "schema",
  "body": "{\"userId\": \"$userId\", \"resource\": \"$resource\", \"resourceId\": \"$resourceId\"}",
  "headers": "{\"Bearer\": \"$bearertoken\", \"customHeader\": \"$customHeader\"}",
  "createdAt": "2024-01-01T09:00:00.00Z",
  "eventType": "submission_approved",
  "projectId": "p2Duhf5N6",
  "id": "a1fb86bad-de7c-4ed7-a1c6-538db2b0c9ed",
  "url": "https://example.com/webhook/$userId",
  "resourceId": "s12RHo2ET"
}

400

Bad Request

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Unauthorized access"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...