Create a webhook endpoint

curl --request POST \
  --url https://api.example.com/api/v1/webhooks/endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "event_types": [
    "<string>"
  ],
  "headers": [
    {
      "name": "<string>",
      "sensitive": true,
      "value": "<string>"
    }
  ],
  "rate_limit_per_sec": 123
}
'

import requests

url = "https://api.example.com/api/v1/webhooks/endpoints"

payload = {
    "url": "<string>",
    "description": "<string>",
    "event_types": ["<string>"],
    "headers": [
        {
            "name": "<string>",
            "sensitive": True,
            "value": "<string>"
        }
    ],
    "rate_limit_per_sec": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    description: '<string>',
    event_types: ['<string>'],
    headers: [{name: '<string>', sensitive: true, value: '<string>'}],
    rate_limit_per_sec: 123
  })
};

fetch('https://api.example.com/api/v1/webhooks/endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/webhooks/endpoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'description' => '<string>',
    'event_types' => [
        '<string>'
    ],
    'headers' => [
        [
                'name' => '<string>',
                'sensitive' => true,
                'value' => '<string>'
        ]
    ],
    'rate_limit_per_sec' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/api/v1/webhooks/endpoints"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"sensitive\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"rate_limit_per_sec\": 123\n}")

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

	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))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/webhooks/endpoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"sensitive\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"rate_limit_per_sec\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/webhooks/endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"sensitive\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"rate_limit_per_sec\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "disabled": true,
  "event_types": [
    "<string>"
  ],
  "headers": [
    {
      "name": "<string>",
      "sensitive": true,
      "set": true,
      "value": "<string>"
    }
  ],
  "id": "whe_7n42DGM5Tflk9n8mt7Fhc7",
  "max_in_flight": 123,
  "needs_setup": true,
  "url": "<string>",
  "secret": "<string>",
  "description": "<string>",
  "disabled_reason": "MANUAL",
  "last_failure_at": "2023-11-07T05:31:56Z",
  "last_success_at": "2023-11-07T05:31:56Z",
  "paused_until": "2023-11-07T05:31:56Z",
  "rate_limit_per_sec": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "BAD_REQUEST",
  "message": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "<string>"
}

POST

api

webhooks

endpoints

Create a webhook endpoint

curl --request POST \
  --url https://api.example.com/api/v1/webhooks/endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "event_types": [
    "<string>"
  ],
  "headers": [
    {
      "name": "<string>",
      "sensitive": true,
      "value": "<string>"
    }
  ],
  "rate_limit_per_sec": 123
}
'

import requests

url = "https://api.example.com/api/v1/webhooks/endpoints"

payload = {
    "url": "<string>",
    "description": "<string>",
    "event_types": ["<string>"],
    "headers": [
        {
            "name": "<string>",
            "sensitive": True,
            "value": "<string>"
        }
    ],
    "rate_limit_per_sec": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    description: '<string>',
    event_types: ['<string>'],
    headers: [{name: '<string>', sensitive: true, value: '<string>'}],
    rate_limit_per_sec: 123
  })
};

fetch('https://api.example.com/api/v1/webhooks/endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/webhooks/endpoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'description' => '<string>',
    'event_types' => [
        '<string>'
    ],
    'headers' => [
        [
                'name' => '<string>',
                'sensitive' => true,
                'value' => '<string>'
        ]
    ],
    'rate_limit_per_sec' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/api/v1/webhooks/endpoints"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"sensitive\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"rate_limit_per_sec\": 123\n}")

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

	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))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/webhooks/endpoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"sensitive\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"rate_limit_per_sec\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/webhooks/endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"headers\": [\n    {\n      \"name\": \"<string>\",\n      \"sensitive\": true,\n      \"value\": \"<string>\"\n    }\n  ],\n  \"rate_limit_per_sec\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "disabled": true,
  "event_types": [
    "<string>"
  ],
  "headers": [
    {
      "name": "<string>",
      "sensitive": true,
      "set": true,
      "value": "<string>"
    }
  ],
  "id": "whe_7n42DGM5Tflk9n8mt7Fhc7",
  "max_in_flight": 123,
  "needs_setup": true,
  "url": "<string>",
  "secret": "<string>",
  "description": "<string>",
  "disabled_reason": "MANUAL",
  "last_failure_at": "2023-11-07T05:31:56Z",
  "last_success_at": "2023-11-07T05:31:56Z",
  "paused_until": "2023-11-07T05:31:56Z",
  "rate_limit_per_sec": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "BAD_REQUEST",
  "message": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

url

string

required

HTTPS destination. Private and loopback addresses are rejected unless the instance is configured to allow them.

description

string | null

event_types

string[]

Event types to subscribe to. Omit or leave empty to receive every event type.

headers

object[]

Custom headers sent with every delivery.

Show child attributes

rate_limit_per_sec

integer<int32> | null

Deliveries started per second, at most (1 to 1000).

Response

Webhook endpoint created

The signing secret is returned in full here and never again outside the reveal and rotate endpoints.

consecutive_failures

integer<int32>

required

Failures since the last success, reset to 0 on any 2xx.

created_at

string<date-time>

required

disabled

boolean

required

event_types

string[]

required

Subscribed event types. Empty means every event type.

headers

object[]

required

Custom headers sent with every delivery.

Show child attributes

string<MeteroidId>

required

Example:

"whe_7n42DGM5Tflk9n8mt7Fhc7"

max_in_flight

integer<int32>

required

How many deliveries this endpoint may have in flight at once. Read-only; it is set from the tenant's environment when the endpoint is created.

needs_setup

boolean

required

A sensitive header still waits for its value; the endpoint cannot be enabled until it is set.

url

string

required

secret

string

required

description

string | null

disabled_reason

enum<string> | null

Available options:

MANUAL,

AUTO_FAILURES,

GONE

last_failure_at

string<date-time> | null

last_success_at

string<date-time> | null

paused_until

string<date-time> | null

The endpoint was unreachable several times in a row: nothing is sent before this time, then it is retried one delivery at a time until it answers again.

rate_limit_per_sec

integer<int32> | null

Deliveries started per second, at most.

updated_at

string<date-time> | null

Add-ons

Batch Jobs

Checkout Sessions

Connect

Coupons

Credit Notes

Custom Properties

Customers

Entitlements

Events

Features

Invoices

Metrics

OAuth Apps

OAuth

Plans

Product Families

Products

Subscriptions

Usage

Webhook Endpoints

webhooks

Create a webhook endpoint

Authorizations

Body

Response