Skip to content

Mapscale Webhook Configuration and Management

Get All Webhook Configurations

Endpoint:

GET api/v9/mapscale/clients/{clientIdentifier}/floor-plan-jobs/configurations/webhooks

Description:

Returns all webhook configurations for a client.

Success Response:

[
  {
    "id": "6b46c3f7-0fe3-495c-829d-104cbb4f35ee",
    "url": "https://example.com/webhook",
    "headerKey": "Authorization",
    "headerValue": "Bearer token_value",
    "retryCountMax": 20,
    "retryIntervalInSecond": 60,
    "retryFailureNotifyAddress": [
      "email1@example.com",
      "email2@example.com"
    ]
  }
]


* You can access the possible response codes you may encounter here.

Get Webhook Configuration

Endpoint:

GET api/v9/mapscale/clients/{clientIdentifier}/floor-plan-jobs/configurations/webhooks/{identifier}

Description:

Returns a single webhook configuration.

Success Response:

{
  "id": "33c453db-8776-4029-bcf0-92a4b6e3b114",
  "url": "https://example.com/webhook",
  "headerKey": "Authorization",
  "headerValue": "Bearer token_value",
  "retryCountMax": 20,
  "retryIntervalInSecond": 60,
  "retryFailureNotifyAddress": [
    "email1@example.com",
    "email2@example.com"
  ]
}


* You can access the possible response codes you may encounter here.

Create Webhook Configuration

Endpoint:

POST api/v9/mapscale/clients/{clientIdentifier}/floor-plan-jobs/configurations/webhooks

Description:

Creates a new webhook configuration for floor plan jobs.

Validations
  • Url: Must provide a valid and unique webhook URL.
  • RetryCountMax: Optional, defaults to 20, must be in the range of 0-20.
  • RetryIntervalInSecond: Optional, defaults to 60, must be in the range of 60-900.
  • RetryFailureNotifyAddress: Optional, used for notifications when retry threshold is reached.

Optional Fields:

  • HeaderKey
  • HeaderValue

Some systems require security headers, such as an authorization token, to be included in webhook requests.

Request Body:

{
  "url": "https://xyz.com/webhook",
  "headerKey": "Authorization",
  "headerValue": "Bearer xxxxx",
  "retryCountMax": 20,
  "retryIntervalInSecond": 60,
  "retryFailureNotifyAddress": [
    "xxx@pointr.tech",
    "yyy@pointr.tech",
    "zzz@pointr.tech"
  ]
}

Success Response: 

{
  "webhookIdentifier": "6b46c3f7-0fe3-495c-829d-104cbb4f35ee"
}


* You can access the possible response codes you may encounter here.

Update Webhook Configuration

Endpoint:

PUT api/v9/mapscale/clients/{clientIdentifier}/floor-plan-jobs/configurations/webhooks/{identifier}

Description:

Updates an existing webhook configuration.

Validations
  • Url: Must provide a valid and unique webhook URL.
  • RetryCountMax: Optional, defaults to 20, must be in the range of 0-20.
  • RetryIntervalInSecond: Optional, defaults to 60, must be in the range of 60-900.
  • RetryFailureNotifyAddress: Optional, used for notifications when retry threshold is reached.

Optional Fields:

  • HeaderKey
  • HeaderValue

Some systems require security headers, such as an authorization token, to be included in webhook requests.

Request Body:

{
  "url": "https://xyz.com/webhook",
  "headerKey": "Authorization",
  "headerValue": "Bearer xxxxx",
  "retryCountMax": 20,
  "retryIntervalInSecond": 60,
  "retryFailureNotifyAddress": [
    "xxx@pointr.tech",
    "yyy@pointr.tech",
    "zzz@pointr.tech"
  ]
}

Success Response:

{
  "webhookIdentifier": "6b46c3f7-0fe3-495c-829d-104cbb4f35ee"
}


* You can access the possible response codes you may encounter here.

Delete Webhook Configuration

Endpoint:

DELETE api/v9/mapscale/clients/{clientIdentifier}/floor-plan-jobs/configurations/webhooks/{identifier}

Description:

Deletes a webhook configuration.

Success Response: 

Empty Response


* You can access the possible response codes you may encounter here.

Get Mapscale Webhooks

Endpoint:

GET api/v9/mapscale/clients/{clientIdentifier}/floor-plan-jobs/webhooks

Description:

Returns webhook notifications related to floor plan jobs.

Success Response:

{
  "webhookNotifications": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "message": "{\"cid\":\"d744aaf9-d3dc-4d2f-9642-543b7b338b04\",\"sid\":\"f2550636-e9e4-48e0-8d70-30fbff36934d\",\"bid\":\"152aefd7-2c58-43d8-8e8a-50b25addd025\",\"lvl\":1,\"username\":\"System\",\"dateTimeEpoch\":1714330101,\"operationType\":\"UPDATE\",\"contentType\":\"FLOORPLANJOB\",\"floorPlanJobId\":\"cd68706d-8662-4cc4-973a-38097cbf4d68\",\"status\":\"Success\"}",
      "responseMessage": "OK",
      "responseStatusCode": 200,
      "tryCount": 1,
      "firstRequestDateTime": "2024-10-16T12:34:56Z",
      "lastRequestDateTime": "2024-10-16T12:35:56Z",
      "webhookConfigurationUrl": "https://example.com/webhook",
      "webhookConfigurationHeaderKey": "Authorization",
      "webhookConfigurationHeaderValue": "Bearer token_value"
    }
  ],
  "totalCount": 10,
  "pageNumber": 1
}


* You can access the possible response codes you may encounter here.

Resend Webhook

Endpoint:

POST api/v9/mapscale/clients/{clientIdentifier}/floor-plan-jobs/webhooks/resend/{identifier}

Description:

Resends a webhook by specifying the {identifier}.

Success Response:

{
  "message": "Resending webhook is successfull"
}

Notes:

  • Webhooks send notifications to specified systems. If a notification is missed or a resend is requested, this endpoint triggers another sending attempt.


* You can access the possible response codes you may encounter here.