Skip to content

Webhooks Management

Get Webhook Configurations

Endpoint:

GET api/v9/content/webhooks/clients/{clientIdentifier}/webhook-configurations

Description:

Gets a list of webhook configurations for the specified client.

Success Response: 

[
  {
    "id": "b3ebc09f-fa05-40ea-bb30-d0657eba5259",
    "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/content/webhooks/clients/{clientIdentifier}/webhook-configurations/{webhookConfigIdentifier}

Description:

Gets details of a specific webhook configuration by its identifier.

Success Response: 

{
  "id": "b3ebc09f-fa05-40ea-bb30-d0657eba5259",
  "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/content/webhooks/clients/{clientIdentifier}/webhook-configurations

Description:

Creates a new webhook configuration for the specified client.

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: 

{
  "url": "https://example.com/webhook",
  "headerKey": "Authorization",
  "headerValue": "Bearer token_value",
  "retryCountMax": 20,
  "retryIntervalInSecond": 60,
  "retryFailureNotifyAddress": [
    "email1@example.com",
    "email2@example.com"
  ]
}

Success Response: 

{
  "message": "Webhook configuration created successfully.",
  "id": "new_configuration_id"
}


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

Update Webhook Configuration

Endpoint:

PUT api/v9/content/webhooks/clients/{clientIdentifier}/webhook-configurations/{webhookConfigIdentifier}

Description:

Updates the webhook configuration identified by {webhookConfigIdentifier}.

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:

{
  "url": "https://updated-url.com/webhook",
  "headerKey": "Authorization",
  "headerValue": "Bearer updated_token",
  "retryCountMax": 15,
  "retryIntervalInSecond": 120,
  "retryFailureNotifyAddress": [
    "email1@example.com",
    "email3@example.com"
  ]
}

Success Response:

{
  "message": "Webhook configuration updated successfully."
}


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

Delete Webhook Configuration

Endpoint:

DELETE api/v9/content/webhooks/clients/{clientIdentifier}/webhook-configurations/{webhookConfigIdentifier}

Description:
Deletes the specified webhook configuration.

Success Response: 

{
  "message": "Webhook configuration deleted successfully."
}


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

Webhook Notifications

Get Webhook Notifications

Endpoint:

GET api/v9/content/webhooks/clients/{clientIdentifier}/webhook-notifications

Description:

Gets the list of webhook notifications for the specified client.

Success Response: 

{
  "webhookNotifications": [
    {
      "id": "4227af0b-b459-4c34-bb41-1418e6468ca0",
      "message": "{\"cid\":\"30c7f59a-4348-4471-b020-6f24da0acdcd\",\"sid\":\"de57668b-1e5e-4cb7-bd2f-d6489ab0bc44\",\"bid\":\"bcf7d7dc-b4fa-4ddf-a3fe-7e8bf3dce054\",\"lvl\":1,\"userName\":\"user@pointr.tech\",\"dateTimeEpoch\":1712306082,\"operationType\":\"CREATE\",\"contentType\":\"BEACON\"}",
      "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 Notification

Endpoint:

POST api/v9/content/webhooks/clients/{clientIdentifier}/webhook-notifications/{notificationIdentifier}/resend

Description:

Resends a specific webhook notification identified by {notificationIdentifier}.

Success Response: 

{
  "message": "Webhook notification resent successfully."
}


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