Create WebhookSubscription

POST

/webhook-subscriptions

Portals

Request

Body Params application/vnd.api+json

data

object

required

type

enum<string>

required

Identifies the Resource.

Allowed value:

WebhookSubscription

Example:

WebhookSubscription

attributes

object

required

relationships

object

optional

Example

{
    "data": {
        "type": "WebhookSubscription",
        "attributes": {
            "eventName": "assignment.complete",
            "targetUrl": "string",
            "basicAuth": {
                "username": "string",
                "password": "string"
            },
            "active": true
        },
        "relationships": {}
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/webhook-subscriptions' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "WebhookSubscription",
        "attributes": {
            "eventName": "assignment.complete",
            "targetUrl": "string",
            "basicAuth": {
                "username": "string",
                "password": "string"
            },
            "active": true
        },
        "relationships": {}
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

data

object (WebhookSubscription)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

WebhookSubscription

Example:

WebhookSubscription

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "WebhookSubscription",
        "attributes": {
            "eventName": "assignment.complete",
            "targetUrl": "string",
            "basicAuth": {
                "username": "string",
                "password": "string"
            },
            "active": true
        },
        "relationships": {}
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409

Modified at 2025-07-08 10:51:22

Delete SubPortal

List WebhookSubscriptions