Interface WebHooks

interface WebHooks {
    active: boolean;
    filters?: WebhookFilter[];
    headers: WebhookHeader[];
    httpBasicPassword?: string;
    httpBasicUsername?: string;
    name: string;
    sys: BasicMetaSysProps & {
        space: SysLink;
    };
    topics: string[];
    transformation?: WebhookTransformation;
    url: string;
    delete(): Promise<void>;
    getCall(id: string): Promise<WebhookCallDetailsProps>;
    getCalls(): Promise<CollectionProp<{
        errors: any[];
        eventType: string;
        requestAt: string;
        responseAt: string;
        statusCode: number;
        sys: {
            createdAt: string;
            createdBy?: SysLink;
            id: string;
            type: string;
        };
        url: string;
    }>>;
    getHealth(): Promise<WebhookHealthProps>;
    toPlainObject(): WebhookProps;
    update(): Promise<WebHooks>;
}

Hierarchy (view full)

Properties

active filters? headers httpBasicPassword? httpBasicUsername? name sys topics transformation? url

Methods

delete getCall getCalls getHealth toPlainObject update

Properties

active

active: boolean

Whether the Webhook is active. If set to false, no calls will be made

Optionalfilters

filters?: WebhookFilter[]

Webhook filters

headers

headers: WebhookHeader[]

Headers that should be appended to the webhook request

OptionalhttpBasicPassword

httpBasicPassword?: string

Password for basic http auth

OptionalhttpBasicUsername

httpBasicUsername?: string

Username for basic http auth

name

name: string

Webhook name

sys

sys: BasicMetaSysProps & {
    space: SysLink;
}

System metadata

topics

topics: string[]

Topics the webhook wants to subscribe to

Optionaltransformation

transformation?: WebhookTransformation

Transformation to apply

url

url: string

Webhook url

Methods

delete

  • delete(): Promise<void>

  • Deletes this object on the server.

    Returns Promise<void>

    Promise for the deletion. It contains no data, but the Promise error case should be handled.

    const contentful = require('contentful-management')

    const client = contentful.createClient({
      accessToken: '<content_management_api_key>'
    })

    client.getSpace('<space_id>')
    .then((space) => space.getWebhook('<webhook_id>'))
    .then((webhook) => webhook.delete())
    .then((webhook) => console.log(`webhook ${webhook.sys.id} updated.`))
    .catch(console.error)

getCall

getCalls

  • getCalls(): Promise<CollectionProp<{
        errors: any[];
        eventType: string;
        requestAt: string;
        responseAt: string;
        statusCode: number;
        sys: {
            createdAt: string;
            createdBy?: SysLink;
            id: string;
            type: string;
        };
        url: string;
    }>>

  • List of the most recent webhook calls. See https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-overviews for more details.

    Returns Promise<CollectionProp<{
        errors: any[];
        eventType: string;
        requestAt: string;
        responseAt: string;
        statusCode: number;
        sys: {
            createdAt: string;
            createdBy?: SysLink;
            id: string;
            type: string;
        };
        url: string;
    }>>

    Promise for list of calls

    const contentful = require('contentful-management')

    const client = contentful.createClient({
      accessToken: '<content_management_api_key>'
    })

    client.getSpace('<space_id>')
    .then((space) => space.getWebhook('<webhook_id>'))
    .then((webhook) => webhook.getCalls())
    .then((response) => console.log(response.items)) // webhook calls
    .catch(console.error)

getHealth

toPlainObject

update

  • update(): Promise<WebHooks>

  • Sends an update to the server with any changes made to the object's properties

    Returns Promise<WebHooks>

    Object returned from the server with updated changes.

    const contentful = require('contentful-management')

    const client = contentful.createClient({
      accessToken: '<content_management_api_key>'
    })

    client.getSpace('<space_id>')
    .then((space) => space.getWebhook('<webhook_id>'))
    .then((webhook) => {
     webhook.name = 'new webhook name'
     return webhook.update()
    })
    .then((webhook) => console.log(`webhook ${webhook.sys.id} updated.`))
    .catch(console.error)

Settings

Member Visibility

On This Page

Properties
Methods