Subscriber Webhook API

GET

/v1/webhooks/{webhook_id}

(subscriber)

Get Webhook

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
webhook_id	url	string	Webhook Id.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
context	body	string	Context.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
ssl_verify	body	boolean	Ssl Verify.
url	body	string	Url.
wh_trigger	body	string	Wh Trigger.

Response Example

{
    "id": "6962a8c8-d3df-11ef-aa98-79d85e6cbbe2",
    "domain": "interstellio.io",
    "url": "http://localhost:9595",
    "ssl_verify": false,
    "context": "radius-authentication",
    "wh_trigger": "subscriber-nas-updated",
}

GET

/v1/webhooks

(subscriber)

List Webhooks

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
p	query	integer	Paginate Current Page. (default 1)

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
context	body	string	Context.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)
ssl_verify	body	boolean	Ssl Verify.
url	body	string	Url.
wh_trigger	body	string	Wh Trigger.

Response Example

{
    "payload": [
        {
            "id": "6962a8c8-d3df-11ef-aa98-79d85e6cbbe2",
            "domain": "interstellio.io",
            "url": "http://localhost:9595",
            "ssl_verify": false,
            "context": "radius-authentication",
            "wh_trigger": "subscriber-nas-updated",
        }
    ],
    "metadata": {
        "records": 1,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

POST

/v1/webhooks

(subscriber)

Create Webhook

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
context	body	string	Context.
ssl_verify	body	boolean	Ssl Verify.
url	body	string	Url.
wh_trigger	body	string	Wh Trigger.

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
context	body	string	Context.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
ssl_verify	body	boolean	Ssl Verify.
url	body	string	Url.
wh_trigger	body	string	Wh Trigger.

Response Example

{
    "id": "6962a8c8-d3df-11ef-aa98-79d85e6cbbe2",
    "domain": "interstellio.io",
    "url": "http://localhost:9595",
    "ssl_verify": false,
    "context": "radius-authentication",
    "wh_trigger": "subscriber-nas-updated",
}

PUT

/v1/webhooks/{webhook_id}

(subscriber)

Edit Webhook

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
webhook_id	url	string	Webhook Id.	X
context	body	string	Context.
ssl_verify	body	boolean	Ssl Verify.
url	body	string	Url.
wh_trigger	body	string	Wh Trigger.

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
context	body	string	Context.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
ssl_verify	body	boolean	Ssl Verify.
url	body	string	Url.
wh_trigger	body	string	Wh Trigger.

Response Example

{
    "id": "6962a8c8-d3df-11ef-aa98-79d85e6cbbe2",
    "domain": "interstellio.io",
    "url": "http://localhost:9595",
    "ssl_verify": false,
    "context": "radius-authentication",
    "wh_trigger": "subscriber-nas-updated",
}

DELETE

/v1/webhooks/{webhook_id}

(subscriber)

Delete Webhook

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
webhook_id	url	string	Webhook Id.	X

Response Status Codes

Code	Meaning
204	OK - No Content
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

GET

/v1/webhooks/contexts

(subscriber)

Get Webhook Contexts

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
contexts	body	array	Contexts.

Response Example

[
    "radius-authentication",
]

GET

/v1/webhooks/triggers

(subscriber)

Get Webhook Triggers

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
contexts	body	array	Contexts.

Response Example

[
    "subscriber-nas-updated",
]

GET

/v1/webhook_worker/status

(subscriber)

Get Current Domain Webhook Worker Status

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
status	body	string	Status.

Response Example

{
    "status": "active"
}

POST

/v1/webhook_worker/enable

(subscriber)

Enable Current Domain Webhook Worker

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

POST

/v1/webhook_worker/disable

(subscriber)

Disable Current Domain Webhook Worker

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable