---
title: WebhookService
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-webhookservice
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-webhookservice.html
section_ids:
  sec-amster-entity-webhookservice-realm-ops: Realm Operations
  sec-amster-entity-webhookservice-realm-ops-create: create
  sec-amster-entity-webhookservice-realm-ops-delete: delete
  sec-amster-entity-webhookservice-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-webhookservice-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-webhookservice-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-webhookservice-realm-ops-query: query
  sec-amster-entity-webhookservice-realm-ops-read: read
  sec-amster-entity-webhookservice-realm-ops-update: update
  sec-amster-entity-webhookservice-global-ops: Global Operations
  sec-amster-entity-webhookservice-global-ops-getalltypes: getAllTypes
  sec-amster-entity-webhookservice-global-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-webhookservice-global-ops-nextdescendents: nextdescendents
  sec-amster-entity-webhookservice-global-ops-read: read
  sec-amster-entity-webhookservice-global-ops-update: update
---

# WebhookService

## Realm Operations

Resource path:

```
/realm-config/webhooks
```

Resource version: `0.0`

### create

**Usage**

```
am> create WebhookService --realm Realm --id id --body body
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "url" : {
        "title" : "Url",
        "description" : "The webhook url that is used to create the http call for this webhook.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "body" : {
        "title" : "Body",
        "description" : "The webhook body to be sent in the http request.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "headers" : {
        "title" : "Headers",
        "description" : "The webhook headers added to the http request. If no User-Agent header is specified, a default 'PingAM' User-Agent is used.",
        "propertyOrder" : 300,
        "required" : true,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete WebhookService --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action WebhookService --realm Realm --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action WebhookService --realm Realm --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action WebhookService --realm Realm --actionName nextdescendents
```

### query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

**Usage**

```
am> query WebhookService --realm Realm --filter filter
```

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all.

### read

**Usage**

```
am> read WebhookService --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update WebhookService --realm Realm --id id --body body
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "url" : {
        "title" : "Url",
        "description" : "The webhook url that is used to create the http call for this webhook.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "body" : {
        "title" : "Body",
        "description" : "The webhook body to be sent in the http request.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "headers" : {
        "title" : "Headers",
        "description" : "The webhook headers added to the http request. If no User-Agent header is specified, a default 'PingAM' User-Agent is used.",
        "propertyOrder" : 300,
        "required" : true,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      }
    }
  }
  ```

## Global Operations

Resource path:

```
/global-config/webhooks
```

Resource version: `1.0`

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action WebhookService --global --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action WebhookService --global --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action WebhookService --global --actionName nextdescendents
```

### read

**Usage**

```
am> read WebhookService --global
```

### update

**Usage**

```
am> update WebhookService --global --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object"
  }
  ```