Add a Webhook

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/656/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 client

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('spaces/656/webhook_endpoints/', {
  "webhook_endpoint": {
    "actions": [
      "story.published"
    ],
    "activated": true,
    "endpoint": "https://apiendpoint.com",
    "name": "Rebuild Website",
    "secret": ""
  }
})
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP client

$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/656/webhook_endpoints/', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/656/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/656/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/656/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/656/webhook_endpoints/', payload)

Swift

import Foundation

let headers = [
  "Content-Type": "application/json",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let postData = NSData(data: {"webhook_endpoint":{"actions":["story.published"],"activated":true,"endpoint":"https://apiendpoint.com","name":"Rebuild Website","secret":""}}.data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/656/webhook_endpoints/")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()