Webhooks (Admin)

To start receiving commerce service webhooks in your application, you must first create some webhook configuration inside your company.

Basically, that configurations defines what is the endpoint that commerce service should call when some event happens and it defines also the signature key that the endpoint should use to validate the request.

To understand how to verify webhook signatures and what are the available webhook events, please visit Webhooks Page.

Webhook Configuration Model (Example)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2022-11-04T13:36:47.665Z",
  "updatedAt": "2022-11-04T13:36:47.665Z",
  "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "company": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2022-11-04T13:36:47.665Z",
    "updatedAt": "2022-11-04T13:36:47.665Z",
    "name": "string"
  },
  "webhookUrl": "https://mydomain.hook.me",
  "signatureKey": "string",
  "maxRetries": 5,
  "disabled": false
}

Service Methods

Creates a new Webhook Configuration inside a company

The signature key could not be changed and is automatically generated. Each configuration has it owns signature key. To be safe, you must ensure that your endpoint will accept request only from our service by checking the signature.

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Lists all webhook configurations from some company

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Gets some webhook configuration of a company by ID

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Updates some company webhook configuration

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Enables some disabled company webhook configuration

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Disabled some enabled company webhook configuration

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Lists all events sent by some webhook configuration

With that sent webhook event entity, you can also know the result of the request and the last result that your configured endpoint returned to the commerce service.

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Gets some webhook event sent by some webhook configuration by ID

Rest API reference:

Error while loading OpenAPI operation — Failed to fetch OpenAPI file