Add a Webhook

POST

https://mapi.storyblok.com/v1/spaces/:space_id/webhook_endpoints

You can set some of the fields available in the webhook object, below we only list the properties in the example and the possible required fields.

Path parameters

• :space_id required number

  Numeric ID of a space

Request body properties

• webhook_endpoint The Webhook Object

  Webhook object

Response properties

• webhook_endpoint The Webhook Object

  Webhook object

Examples

cURL

curl "https://mapi.storyblok.com/v1/spaces/288868932106293/webhook_endpoints/" \
  -X POST \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"webhook_endpoint\":{\"actions\":[\"story.published\"],\"activated\":true,\"endpoint\":\"https://apiendpoint.com\",\"name\":\"Rebuild Website\",\"secret\":\"\"}}"

JS

// storyblok-js-client@>=7, node@>=18
import Storyblok from "storyblok-js-client";

const storyblok = new Storyblok({
  oauthToken: "YOUR_PERSONAL_ACCESS_TOKEN",
});

try {
  const response = await storyblok.post('spaces/288868932106293/webhook_endpoints/', {
  "webhook_endpoint": {
    "actions": [
      "story.published"
    ],
    "activated": true,
    "endpoint": "https://apiendpoint.com",
    "name": "Rebuild Website",
    "secret": ""
  }
})
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$payload = ["webhook_endpoint" => ["actions" => ["story.published"],"activated" => true,"endpoint" => "https => //apiendpoint.com","name" => "Rebuild Website","secret" => ""]];

$client->post('spaces/288868932106293/webhook_endpoints/', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/288868932106293/webhook_endpoints/")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body({"webhook_endpoint":{"actions":["story.published"],"activated":true,"endpoint":"https://apiendpoint.com","name":"Rebuild Website","secret":""}})
  .asString();

C#

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/288868932106293/webhook_endpoints/");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"webhook_endpoint\":{\"actions\":[\"story.published\"],\"activated\":true,\"endpoint\":\"https://apiendpoint.com\",\"name\":\"Rebuild Website\",\"secret\":\"\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/288868932106293/webhook_endpoints/"

querystring = {}

payload = {"webhook_endpoint":{"actions":["story.published"],"activated":true,"endpoint":"https://apiendpoint.com","name":"Rebuild Website","secret":""}}
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("POST", url, data=payload, headers=headers, params=querystring)

print(response.text)

Ruby

require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

payload = {"webhook_endpoint" => {"actions" => ["story.published"],"activated" => true,"endpoint" => "https => //apiendpoint.com","name" => "Rebuild Website","secret" => ""}}

client.post('spaces/288868932106293/webhook_endpoints/', payload)

Swift

let storyblok = URLSession(storyblok: .mapi(accessToken: .oauth("YOUR_OAUTH_TOKEN")))
var request = URLRequest(storyblok: storyblok, path: "spaces/288868932106293/webhook_endpoints/")
request.httpMethod = "POST"
request.httpBody = try JSONSerialization.data(withJSONObject: [
    "webhook_endpoint": [
        "actions": [
            "story.published",
        ],
        "activated": true,
        "endpoint": "https://apiendpoint.com",
        "name": "Rebuild Website",
        "secret": "",
    ],
])
let (data, _) = try await storyblok.data(for: request)
print(try JSONSerialization.jsonObject(with: data))

Kotlin

val client = HttpClient {
    install(Storyblok(MAPI)) {
        accessToken = OAuth("YOUR_OAUTH_TOKEN")
    }
}

val response = client.post("spaces/288868932106293/webhook_endpoints/") {
    setBody(buildJsonObject {
        putJsonObject("webhook_endpoint") {
            putJsonArray("actions") {
                add("story.published")
            }
            put("activated", true)
            put("endpoint", "https://apiendpoint.com")
            put("name", "Rebuild Website")
            put("secret", "")
        }
    })
}

println(response.body<JsonElement>())