Creates a webhook

POST

https://api.promptmate.io/v1/webhooks

Creates a webhook. Rate limit is 500 requests per minute.

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Header Params

Body Params application/json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.promptmate.io/v1/webhooks' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "webhookName": "string",
    "restrictedAppIds": [
        "string"
    ],
    "webhookType": "job",
    "endpointUrl": "string",
    "webhookReference": "string"
}'

Responses

🟢200OK

application/json

The created webhook

Body

Example

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

🔴500Server Error

Modified at 2025-05-17 10:21:41

Lists webhooks

Deletes a webhook