Creates a webhook - promptmate.io API

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

x-api-key

string

required

Example:

YOUR_API_KEY

User-Agent

string

optional

Example:

promptmate.io

Body Params application/json

Represents a request to create a new webhook.

webhookName

string

optional

Name of the webhook.

restrictedAppIds

array[string]

optional

Restrict the webhook to specific apps. If no apps defined it will be triggered for all apps.

webhookType

enum<string>

optional

'job' triggers the webhook after the complete job has finished. 'row' triggers the webhook after each row has finished. The data which will be send is an array with the result data (in case of row it will contain only one)

Allowed values:

jobrow

endpointUrl

string

optional

URL of which will be called by the webhook.

webhookReference

string

optional

Your webhook reference, can be used to delete it.

Example

{
  "webhookName": "string",
  "restrictedAppIds": [
    "string"
  ],
  "webhookType": "job",
  "endpointUrl": "string",
  "webhookReference": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.promptmate.io/v1/webhooks' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw ''

Responses

🟢200OK

application/json

The created webhook

Body

array of:

webhookId

string

optional

Unique identifier for the webhook.

webhookName

string

optional

Name of the webhook.

restrictedAppIds

array[string]

optional

Restrict the webhook to specific apps. If no apps defined it will be triggered for all apps.

webhookType

enum<string>

optional

'job' triggers the webhook after the complete job has finished. 'row' triggers the webhook after each row has finished. The data which will be send is an array with the result data (in case of row it will contain only one)

Allowed values:

jobrow

endpointUrl

string

optional

URL of which will be called by the webhook.

webhookReference

string

optional

Your webhook reference, can be used to delete it.

Example

[
  {
    "webhookId": "string",
    "webhookName": "string",
    "restrictedAppIds": [
      "string"
    ],
    "webhookType": "job",
    "endpointUrl": "string",
    "webhookReference": "string"
  }
]

🔴500Server Error