Webhook subscription details
Retrieve a Webhook subscription from Basecone by the company's unique identifier.
GET subscriptions/:companyid
WebhookSubscription properties
| Property | Type | Description |
|---|---|---|
| Endpoint | Uri | The destination endpoint where basecone will post raised events. |
| Username | String | (optional )The username that will be used for basic authentication at the configured endpoint. |
| Company | complex | Company reference object, all raised events will be related to this company. |
Example response:
{
"endpoint": "https://some.server.com/event",
"username": "",
"company": {
"companyId": "c77a6059-10e8-427c-891b-129e7cc0e403",
"companyCode": "9901",
"_links": [
{
"rel": "self",
"href": "https://secure.basecone.com/v1/api/companies/c77a6059-10e8-427c-891b-129e7cc0e403"
}
]
},
}
CompanyReference properties
| Property | Type | Description |
|---|---|---|
| CompanyId | Guid | Unique identifier of the company. |
| CompanyCode | string | The code of this company. |
{
{
"companyId": "fb8f9584-3fc6-4cc7-abda-530ff397ea82",
"companyCode": "1028",
"_links": [
{
"rel": "self",
"href": "http://api.basecone.com/companies/fb8f9584-3fc6-4cc7-abda-530ff397ea82"
}
]
},
}
