CreateWebhookSubscriptions

Inputs (Array of CreateWebhookSubscription) inherits from EntityBase

Name	Type	Description	Mandatory	Available from version	Additional information

Name

Type

Description

Mandatory

Available from version

Additional information

BrickId

Guid

Not used.

DestinationAddress

String

This is the URL where the request will be sent when an event occurs. The URL must be a HTTPS URL.

HTTP URL will return error.

true

2.27

EventName

String

The name of the event. Available event names can be retrieved by calling GetAvailableWebhookEvents or looking at the documentation Events.

true

2.27

Request example

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns:tns="http://tempuri.org/" xmlns:s1="http://microsoft.com/wsdl/types/" xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/">
    <soap:Body>
        <CreateWebhookSubscriptions xmlns="http://tempuri.org/">
        <req>
            <Credentials>
            <UserName>{{UserName}}</UserName>
            <Password>{{Password}}</Password>
            </Credentials>
            <identify>{{identify}}</identify>
                <Entities>
                    <CreateWebhookSubscription>                   
                        <DestinationAddress>https://test.com/test</DestinationAddress>
                        <EventName>TradeOrderUpdated</EventName>
                    </CreateWebhookSubscription>
                </Entities>
        </req>
        </CreateWebhookSubscriptions>
    </soap:Body>
</soap:Envelope>

Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <CreateWebhookSubscriptionsResponse xmlns="http://tempuri.org/">
            <CreateWebhookSubscriptionsResult>
                <Message>OK</Message>
                <Entities>
                    <CreateWebhookSubscription>
                        <BrickId>00000000-0000-0000-0000-000000000000</BrickId>
                        <CreatedDate>0001-01-01T00:00:00</CreatedDate>
                        <EventName>TradeOrderUpdated</EventName>
                        <DestinationAddress>https://test.com/test</DestinationAddress>
                    </CreateWebhookSubscription>
                </Entities>
            </CreateWebhookSubscriptionsResult>
        </CreateWebhookSubscriptionsResponse>
    </soap:Body>
</soap:Envelope>

BFS API

CreateWebhookSubscriptions

Inputs (Array of CreateWebhookSubscription) inherits from EntityBase

Request example

Response

Related content