Skip to main content
API docs by Redocly

Public Webhooks API (v1)

Download OpenAPI specification:Download

Webhooks API

v1

Get all registered webhooks

Authorizations:
Bearer-Authorization
header Parameters
Ocp-Apim-Subscription-Key
required
string
Example: da7d5b0e18a84aeda961c0c31b75c2a9

APIM Subscription Key

Merchant-Serial-Number
required
string [ 4 .. 6 ] characters ^[0-9]{4,6}$
Example: 123456

The Sales unit's MSN: The unique identifier for the sales unit.

Vipps-System-Name
string
Example: woocommerce

The name of the ecommerce solution. One word in lowercase letters is good.

Vipps-System-Version
string
Example: 5.4.0

The version number of the ecommerce solution.

Vipps-System-Plugin-Name
string
Example: vipps-woocommerce

The name of the ecommerce plugin (if applicable). One word in lowercase letters is good.

Vipps-System-Plugin-Version
string
Example: 1.2.1

The version number of the ecommerce plugin (if applicable).

Responses

Response samples

Content type
application/json
{
  • "webhooks": [
    ]
}

Register webhook

At most 5 webhooks can currently be registered per event, please reach out if a higher limit is required.

Authorizations:
Bearer-Authorization
header Parameters
Ocp-Apim-Subscription-Key
required
string
Example: da7d5b0e18a84aeda961c0c31b75c2a9

APIM Subscription Key

Merchant-Serial-Number
required
string [ 4 .. 6 ] characters ^[0-9]{4,6}$
Example: 123456

The Sales unit's MSN: The unique identifier for the sales unit.

Vipps-System-Name
string
Example: woocommerce

The name of the ecommerce solution. One word in lowercase letters is good.

Vipps-System-Version
string
Example: 5.4.0

The version number of the ecommerce solution.

Vipps-System-Plugin-Name
string
Example: vipps-woocommerce

The name of the ecommerce plugin (if applicable). One word in lowercase letters is good.

Vipps-System-Plugin-Version
string
Example: 1.2.1

The version number of the ecommerce plugin (if applicable).

Request Body schema: application/json
url
required
string <uri>

The URL that updates should be sent to. Must be a valid, world-reachable URL. The URL must use HTTPS. Can not be a URL that redirects to a different URL. We don't send requests to all ports, so to be safe use common ports such as: 80, 443, 8080.

events
required
Array of strings

See Webhooks API Events for details.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "secret": "090a478d-37ff-4e77-970e-d457aeb26a3a"
}

Delete webhook

Authorizations:
Bearer-Authorization
path Parameters
id
required
string <uuid>
header Parameters
Ocp-Apim-Subscription-Key
required
string
Example: da7d5b0e18a84aeda961c0c31b75c2a9

APIM Subscription Key

Merchant-Serial-Number
required
string [ 4 .. 6 ] characters ^[0-9]{4,6}$
Example: 123456

The Sales unit's MSN: The unique identifier for the sales unit.

Vipps-System-Name
string
Example: woocommerce

The name of the ecommerce solution. One word in lowercase letters is good.

Vipps-System-Version
string
Example: 5.4.0

The version number of the ecommerce solution.

Vipps-System-Plugin-Name
string
Example: vipps-woocommerce

The name of the ecommerce plugin (if applicable). One word in lowercase letters is good.

Vipps-System-Plugin-Version
string
Example: 1.2.1

The version number of the ecommerce plugin (if applicable).

Responses

Response samples

Content type
application/problem+json
{
  • "type": "00-bb841c551513e233de8a01472013fa9f-542c71e40916a6ce-00",
  • "title": "Bad Request",
  • "status": 400,
  • "detail": "One or more validation errors occurred.",
  • "instance": "/v1/webhooks",
  • "traceId": "00-bb841c551513e233de8a01472013fa9f-542c71e40916a6ce-00",
  • "extraDetails": [
    ]
}