Retrieve a Single Webhook

Returns a single webhook object by providing a specific numeric ID.

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

Path Parameters

:space_id
required number

Numeric ID of a space
:webhook_endpoint_id
required number

Webhook ID

Response Properties

webhook_endpoint

The Webhook Object

Webhook object

id
number

The numeric ID of the webhook
name
string

Name of this webhook
description
string

A brief description of this webhook
endpoint
string

Webhook endpoint
space_id
number

Numeric ID of a space
secret
string

Webhook secret

actions

enum[]

Webhook triggers, at least one of the options listed below.

Triggers	Description
story.published	A story is published
story.unpublished	A story is unpublished
story.deleted	A story is deleted
story.moved	A story is moved from a folder or to a folder
datasource.entries_updated	A new datasource entry is saved or added.
asset.created	An asset is uploaded
asset.replaced	An asset is replaced
asset.deleted	An asset is deleted
asset.restored	An asset is restored
user.added	A new user is added to the space
user.removed	A user is removed from the space
user.roles_updated	A user role is updated
stage.changed	A workflow stage of a story changed.
pipeline.deployed	A pipeline stage is deployed
release.merged	A release is merged into the currently released content

activated
boolean

Activate or deactivate the current webhook. Default: true when creating a webhook
deleted_at
string

Deleted date (Format: YYYY-mm-dd HH:MM)
created_at
string

Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
updated_at
string

Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

Select a Language

Request

curl "https://mapi.storyblok.com/v1/spaces/656/webhook_endpoints/4570" \
  -X GET \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json"

Request

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.get('/spaces/656/webhook_endpoints/4570', {})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })

Request

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

$client->get('/spaces/656/webhook_endpoints/4570')->getBody();

Request

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

client.false('/spaces/656/webhook_endpoints/4570')

Request

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

Request

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

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

Request

import Foundation

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

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

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

Request

import requests

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

querystring = {}

payload = ""
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

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

print(response.text)

You will receive a webhook object as a response.

Prev The Webhook Object

Next Retrieve Multiple Webhooks