Skip to main content
POST
/
organizations
/
{orgId}
/
integrationdestinations
/
webhooks
Create Webhook Destination
curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/integrationdestinations/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "url": "<string>",
  "credentials": {
    "type": "M3TER_SIGNED_REQUEST",
    "apiKey": "api key",
    "secret": "api secret",
    "version": 123,
    "empty": true,
    "name": "Integration Credentials"
  },
  "version": 123,
  "code": "<string>",
  "active": true
}
'
{
  "id": "<string>",
  "version": 123,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "name": "<string>",
  "description": "<string>",
  "code": "<string>",
  "active": true,
  "url": "<string>",
  "credentials": {
    "id": "<string>",
    "type": "<string>",
    "destination": "<string>",
    "version": 123,
    "dtCreated": "2023-11-07T05:31:56Z",
    "dtLastModified": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "lastModifiedBy": "<string>",
    "destinationId": "<string>",
    "name": "<string>",
    "apiKey": "api key",
    "secret": "api secret"
  }
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

The unique identifier (UUID) for the organization. This specifies the organization within which the webhook destination is created.

Body

application/json

This response contains details about the WebhookDestinationRequest entity, including the URL and credentials required for webhook activation.

​
name
string
required
Minimum string length: 1
​
description
string
required
Minimum string length: 1
​
url
string
required

The URL to which the webhook requests will be sent.

Minimum string length: 1
​
credentials
object
required

The credentials required for the webhook.

​
version
integer<int64>

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
​
code
string
​
active
boolean

Response

Returns the DestinationCreateRequest

Response containing details of a webhook destination.

​
id
string
required

The UUID of the entity.

​
version
integer<int64>

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
​
dtCreated
string<date-time>

The DateTime when this item was created (in ISO-8601 format).

​
dtLastModified
string<date-time>

The DateTime when this item was last modified (in ISO-8601 format).

​
createdBy
string

The ID of the user who created this item.

​
lastModifiedBy
string

The ID of the user who last modified this item.

​
name
string
​
description
string
​
code
string
​
active
boolean
​
url
string

The URL to which webhook requests are sent.

​
credentials
object

This schema defines the credentials required for m3ter request signing.