Create project webhook

POST

platform

projects

{projectId}

webhooks

Create project webhook

curl --request POST \
  --url https://api.polymorfa.com/platform/projects/{projectId}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "url": "<string>",
  "eventTypes": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({url: '<string>', eventTypes: ['<string>']})
};

fetch('https://api.polymorfa.com/platform/projects/{projectId}/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/projects/{projectId}/webhooks"

payload = {
    "url": "<string>",
    "eventTypes": ["<string>"]
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/projects/{projectId}/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"eventTypes\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "webhook": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "owner": "project",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "eventTypes": [
        "<string>"
      ],
      "enabled": true,
      "format": "native",
      "retryPolicy": {
        "maximumAttempts": 5,
        "backoff": "constant",
        "initialDelaySeconds": 1800
      },
      "headers": [
        {
          "name": "<string>"
        }
      ],
      "secret": {
        "version": 2,
        "createdAt": "2023-11-07T05:31:56Z",
        "previousValidUntil": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "operationId": null,
    "idempotency": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "<string>",
      "replayed": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z"
    },
    "secretAvailable": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Headers

Idempotency-Key

string

required

Specifies idempotency key for this header parameter.

Value constraints

Constraint	Accepted input
String length	`1` through `255` characters

Required string length: 1 - 255

Path Parameters

projectId

string<uuid>

required

Identifier of the Polymorfa project that owns this resource.

Value constraints

Constraint	Accepted input
Format	`uuid`

Body

application/json

url

string<uri>

required

URL associated with this resource.

Value constraints

Constraint	Accepted input
String length	`1` through `2048` characters
Format	`uri`

Required string length: 1 - 2048

eventTypes

string[]

required

Names reserved for internal use cannot be newly subscribed. Existing stored entries may be preserved during updates but never match deliveries.

Value constraints

Constraint	Accepted input
Array size	`1` through `100` items
Duplicates	Not accepted; every array item must be unique
Item string length	`1` through `128` characters

Required array length: 1 - 100 elements

Required string length: 1 - 128

enabled

boolean

default:true

Whether this feature is enabled.

format

enum<string>

default:native

Specifies format for this management create project webhook input.

Allowed values

Value	Meaning
`native`	Native.
`meta`	Meta.

Available options:

native,

meta

retryPolicy

object

Specifies retry policy for this management create project webhook input.

Show child attributes

headers

object[]

HTTP headers attached to the outgoing request.

Value constraints

Constraint	Accepted input
Array size	At most `10` items

Maximum array length: 10

Show child attributes

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Create project webhook

curl --request POST \
  --url https://api.polymorfa.com/platform/projects/{projectId}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "url": "<string>",
  "eventTypes": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({url: '<string>', eventTypes: ['<string>']})
};

fetch('https://api.polymorfa.com/platform/projects/{projectId}/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/projects/{projectId}/webhooks"

payload = {
    "url": "<string>",
    "eventTypes": ["<string>"]
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/projects/{projectId}/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"eventTypes\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "webhook": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "owner": "project",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "eventTypes": [
        "<string>"
      ],
      "enabled": true,
      "format": "native",
      "retryPolicy": {
        "maximumAttempts": 5,
        "backoff": "constant",
        "initialDelaySeconds": 1800
      },
      "headers": [
        {
          "name": "<string>"
        }
      ],
      "secret": {
        "version": 2,
        "createdAt": "2023-11-07T05:31:56Z",
        "previousValidUntil": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "operationId": null,
    "idempotency": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "<string>",
      "replayed": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z"
    },
    "secretAvailable": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Create project webhook

Authorizations

Headers

Path Parameters

Body

Response