Retrieve Webhook Actions

GET

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

Returns the list of event actions that can be subscribed to when creating or updating a webhook endpoint.

Caution

This endpoint requires an admin or owner role.

Path parameters

• :space_id required number

  Numeric ID of a space

Response properties

• allowed_actions object[]

  An array of allowed action objects, each containing an action string that identifies the webhook event (for example, story.published). Find all available triggers in the actions table.

Examples

cURL

curl "https://mapi.storyblok.com/v1/spaces/288868932106293/webhook_endpoints/allowed_actions" \
  -H "Authorization: YOUR_OAUTH_TOKEN"

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.get('spaces/288868932106293/webhook_endpoints/allowed_actions', {})
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

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

$client->get('spaces/288868932106293/webhook_endpoints/allowed_actions')->getBody();

Java

HttpResponse<String> response = Unirest.get("https://mapi.storyblok.com/v1/spaces/288868932106293/webhook_endpoints/allowed_actions")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .asString();

C#

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

request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
IRestResponse response = client.Execute(request);

Python

import requests

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

querystring = {}

payload = ""
headers = {
  'Authorization': "YOUR_OAUTH_TOKEN"
}

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

print(response.text)

Ruby

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

client.get('spaces/288868932106293/webhook_endpoints/allowed_actions')

Swift

let storyblok = URLSession(storyblok: .mapi(accessToken: .oauth("YOUR_OAUTH_TOKEN")))
let request = URLRequest(storyblok: storyblok, path: "spaces/288868932106293/webhook_endpoints/allowed_actions")
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.get("spaces/288868932106293/webhook_endpoints/allowed_actions")

println(response.body<JsonElement>())