Webhook Management
/
BurgerService
/
Create a new webhook.

Webhook Management

Our “Burger Service” Webhook Management API provides endpoints to create, retrieve, ingest, trigger, and update webhooks (as well as their invocations), enabling streamlined event-driven integrations.

Languages
Servers
https://{api-domain}.cresta.com/

BurgerService

Operations

Retrieve an individual webhook invocation.

Request

Path
namestringrequired

Resource name of the webhook invocation. Format: customers/{customer_id}/webhooks/{webhook_id}/invocations/{invocation_id}

Query
profileIdstring

The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0131::request-unknown-fields=disabled --).

curl -i -X GET \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/profiles/*/webhooks/*/invocations/*}'

Responses

A successful response.

Bodyapplication/json
webhookInvocationobject(An individual webhook invocation. Next ID: 12)
Response
application/json
{
  "webhookInvocation": {
    "name": "string",
    "requestUri": "string",
    "payload": "string",
    "executionDuration": "string",
    "resolveTime": "2019-08-24T14:15:22Z",
    "resolvedByInvocation": "string",
    "done": true,
    "error": { … },
    "resultStatusDetails": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z"
  }
}

Retrieve an individual webhook.

Request

Path
namestringrequired

Resource name of the webhook. Format: customers/{customer_id}/webhooks/{webhook_id}

Query
profileIdstring

The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0131::request-unknown-fields=disabled --).

curl -i -X GET \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/profiles/*/webhooks/*}'

Responses

A successful response.

Bodyapplication/json
webhookobject(Burger Webhook. Next ID: 12)
Response
application/json
{
  "webhook": {
    "name": "string",
    "displayName": "string",
    "context": "CONTEXT_UNSPECIFIED",
    "webhookType": "WEBHOOK_TYPE_UNSPECIFIED",
    "state": "STATE_UNSPECIFIED",
    "incomingWebhookConfig": { … },
    "outgoingWebhookConfig": { … },
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "creator": "string",
    "lastEditor": "string"
  }
}

Trigger execution of an incoming webhook.

Request

Path
namestringrequired

Resource name of the webhook.

Format: customers/{customer_id}/webhooks/{webhook_id}

Bodyapplication/jsonrequired

The JSON payload of the incoming webhook.

object
curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/profiles/*/webhooks/*}:ingest' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

A successful response.

Bodyapplication/json
invocationstringread-only

The resource name of the created invocation.

Response
application/json
{
  "invocation": "string"
}

Trigger execution of an outgoing webhook.

Request

Path
namestringrequired

Resource name of the webhook. Format: customers/{customer_id}/webhooks/{webhook_id}

Bodyapplication/jsonrequired
triggerSourcestringrequired

A value the caller can use to identify itself and enable later analysis.

conversationNamestring(Format: customers/{customer_id}/profiles/{profile_id}/conversations/{conversation_id})
profileIdstring(The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0131::request-unknown-fields=disabled --))
curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/profiles/*/webhooks/*}:trigger' \
  -H 'Content-Type: application/json' \
  -d '{
    "triggerSource": "string",
    "conversationName": "string",
    "profileId": "string"
  }'

Responses

A successful response.

Bodyapplication/json
invocationstringread-only

The resource name of the created invocation.

Response
application/json
{
  "invocation": "string"
}

Retrieve an individual webhook invocation.

Request

Path
namestringrequired

Resource name of the webhook invocation. Format: customers/{customer_id}/webhooks/{webhook_id}/invocations/{invocation_id}

Query
profileIdstring

The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0131::request-unknown-fields=disabled --).

curl -i -X GET \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/webhooks/*/invocations/*}'

Responses

A successful response.

Bodyapplication/json
webhookInvocationobject(An individual webhook invocation. Next ID: 12)
Response
application/json
{
  "webhookInvocation": {
    "name": "string",
    "requestUri": "string",
    "payload": "string",
    "executionDuration": "string",
    "resolveTime": "2019-08-24T14:15:22Z",
    "resolvedByInvocation": "string",
    "done": true,
    "error": { … },
    "resultStatusDetails": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z"
  }
}

Retrieve an individual webhook.

Request

Path
namestringrequired

Resource name of the webhook. Format: customers/{customer_id}/webhooks/{webhook_id}

Query
profileIdstring

The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0131::request-unknown-fields=disabled --).

curl -i -X GET \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/webhooks/*}'

Responses

A successful response.

Bodyapplication/json
webhookobject(Burger Webhook. Next ID: 12)
Response
application/json
{
  "webhook": {
    "name": "string",
    "displayName": "string",
    "context": "CONTEXT_UNSPECIFIED",
    "webhookType": "WEBHOOK_TYPE_UNSPECIFIED",
    "state": "STATE_UNSPECIFIED",
    "incomingWebhookConfig": { … },
    "outgoingWebhookConfig": { … },
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "creator": "string",
    "lastEditor": "string"
  }
}

Trigger execution of an incoming webhook.

Request

Path
namestringrequired

Resource name of the webhook.

Format: customers/{customer_id}/webhooks/{webhook_id}

Bodyapplication/jsonrequired

The JSON payload of the incoming webhook.

object
curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/webhooks/*}:ingest' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

A successful response.

Bodyapplication/json
invocationstringread-only

The resource name of the created invocation.

Response
application/json
{
  "invocation": "string"
}

Trigger execution of an outgoing webhook.

Request

Path
namestringrequired

Resource name of the webhook. Format: customers/{customer_id}/webhooks/{webhook_id}

Bodyapplication/jsonrequired
triggerSourcestringrequired

A value the caller can use to identify itself and enable later analysis.

conversationNamestring(Format: customers/{customer_id}/profiles/{profile_id}/conversations/{conversation_id})
profileIdstring(The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0131::request-unknown-fields=disabled --))
curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/webhooks/*}:trigger' \
  -H 'Content-Type: application/json' \
  -d '{
    "triggerSource": "string",
    "conversationName": "string",
    "profileId": "string"
  }'

Responses

A successful response.

Bodyapplication/json
invocationstringread-only

The resource name of the created invocation.

Response
application/json
{
  "invocation": "string"
}

Get a list of webhookinvocations.

Request

Path
parentstringrequired

Resource name of the parent. Format: customers/{customer_id}/webhooks/{webhook_id}

Query
pageSizeinteger(int32)

The maximum number of webhook invocations to return. If unspecified, at most 50 will be returned. Ordered by creation date.

pageTokenstring

A page token, received from a previous ListWebhookInvocations call. Provide this to retrieve the subsequent page.

filters.statesArray of strings

Invocation status to filter by (OR combined).

  • INVOCATION_STATUS_UNSPECIFIED: Unspecified - do not use.
  • INVOCATION_STATUS_PENDING: Invocation is still pending completion.
  • INVOCATION_STATUS_SUCCESS: Invocation completed successfully.
  • INVOCATION_STATUS_ERROR: Invocation completed with an error.
Items Enum"INVOCATION_STATUS_UNSPECIFIED""INVOCATION_STATUS_PENDING""INVOCATION_STATUS_SUCCESS""INVOCATION_STATUS_ERROR"
profileIdstring

The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0131::request-unknown-fields=disabled --).

curl -i -X GET \
  'https://{api-domain}.cresta.com/v1/{parent=customers/*/profiles/*/webhooks/*}/invocations'

Responses

A successful response.

Bodyapplication/json
webhookInvocationsArray of objects(An individual webhook invocation. Next ID: 12)read-only

The matching webhooks.

nextPageTokenstring

Token is used to retrieve the next page.

Response
application/json
{
  "webhookInvocations": [
    { … }
  ],
  "nextPageToken": "string"
}

Get a list of webhooks.

Request

Path
parentstringrequired

Resource name of the parent. Format: customers/{customer_id}

Query
pageSizeinteger(int32)

The maximum number of webhooks to return. If unspecified, at most 50 will be returned.

pageTokenstring

A page token, received from a previous ListWebhooks call. Provide this to retrieve the subsequent page.

profileIdstring

The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0131::request-unknown-fields=disabled --).

curl -i -X GET \
  'https://{api-domain}.cresta.com/v1/{parent=customers/*/profiles/*}/webhooks'

Responses

A successful response.

Bodyapplication/json
webhooksArray of objects(Burger Webhook. Next ID: 12)read-only

The matching webhooks.

nextPageTokenstring

Token is used to retrieve the next page.

Response
application/json
{
  "webhooks": [
    { … }
  ],
  "nextPageToken": "string"
}

Create a new webhook.

Request

Path
parentstringrequired

Resource name of the parent. Format: customers/{customer_id}

webhookIdstringrequired

The resource ID of the webhook

Query
profileIdstring

The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0133::request-unknown-fields=disabled --).

Bodyapplication/jsonrequired

The webhook to be created.

namestring(Resource name of a webhook Format: customers/{customer_id}/webhooks/{webhook_id})
displayNamestring(A user-displayed name of the webhook)required
contextstring(WebhookContext)

The available context types for a webhook.

  • CONTEXT_UNSPECIFIED: Unspecified - do not use.
  • CONVERSATION: Conversation.
Default "CONTEXT_UNSPECIFIED"
Enum"CONTEXT_UNSPECIFIED""CONVERSATION"
webhookTypestring(The type of the webhook)
  • WEBHOOK_TYPE_UNSPECIFIED: Unspecified - do not use.
  • INCOMING: An incoming webhook.
  • OUTGOING_SYNC: A synchronous outgoing webhook.
  • OUTGOING_ASYNC: An asynchronous outgoing webhook.
Default "WEBHOOK_TYPE_UNSPECIFIED"
Enum"WEBHOOK_TYPE_UNSPECIFIED""INCOMING""OUTGOING_SYNC""OUTGOING_ASYNC"
statestring(All possible states of an webhook)
  • STATE_UNSPECIFIED: Unspecified - do not use.
  • STATE_ACTIVE: The webhook is active.
  • STATE_INACTIVE: The webhook is inactive and will not be fired.
  • STATE_DELETED: The webhook has been deleted.
Default "STATE_UNSPECIFIED"
Enum"STATE_UNSPECIFIED""STATE_ACTIVE""STATE_INACTIVE""STATE_DELETED"
incomingWebhookConfigobject(Incoming webhook configuration. Next ID: 5)
outgoingWebhookConfigobject(The outgoing webhook config. Next ID: 10)
curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{parent=customers/*/profiles/*}/webhooks/{webhookId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "string",
    "context": "CONTEXT_UNSPECIFIED",
    "webhookType": "WEBHOOK_TYPE_UNSPECIFIED",
    "state": "STATE_UNSPECIFIED",
    "incomingWebhookConfig": {
      "resourceNameJsonPath": "string",
      "externalIdJsonPath": "string",
      "fieldMapping": [
        {
          "fromJsonPath": "string",
          "toMetadataTaxonomy": "string"
        }
      ],
      "basicAuthentication": {
        "username": "string",
        "password": "string"
      },
      "ignoreMissingResource": true
    },
    "outgoingWebhookConfig": {
      "uri": "string",
      "method": "string",
      "basic": {
        "username": "string",
        "password": "string"
      },
      "bearer": {
        "token": "string"
      },
      "oauth2": {
        "grantType": "OAUTH2_GRANT_TYPE_UNSPECIFIED",
        "jwtParameters": {
          "iss": "string",
          "aud": "string",
          "sub": "string",
          "otherInputClaims": {
            "property1": "string",
            "property2": "string"
          },
          "privateKey": "string"
        },
        "clientCredentialParameters": {
          "clientId": "string",
          "clientSecret": "string"
        },
        "passwordCredentialsParameters": {
          "username": "string",
          "password": "string",
          "clientId": "string",
          "clientSecret": "string"
        },
        "scope": "string",
        "accessTokenUri": "string",
        "authStyle": "AUTH_STYLE_UNSPECIFIED",
        "doNotFormUrlencodeBasicAuth": true
      },
      "headers": [
        {
          "name": "string",
          "value": "string",
          "type": "HEADER_TYPE_UNSPECIFIED"
        }
      ],
      "body": "string",
      "bodySyntaxVersion": 0,
      "retryOptions": {
        "maxRetries": 0,
        "minRetryWait": "string",
        "maxRetryWait": "string",
        "timeout": "string",
        "retryStatusCodes": [
          0
        ]
      }
    }
  }'

Responses

A successful response.

Bodyapplication/json
webhookobject(Burger Webhook. Next ID: 12)
Response
application/json
{
  "webhook": {
    "name": "string",
    "displayName": "string",
    "context": "CONTEXT_UNSPECIFIED",
    "webhookType": "WEBHOOK_TYPE_UNSPECIFIED",
    "state": "STATE_UNSPECIFIED",
    "incomingWebhookConfig": { … },
    "outgoingWebhookConfig": { … },
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "creator": "string",
    "lastEditor": "string"
  }
}

Get a list of webhookinvocations.

Request

Path
parentstringrequired

Resource name of the parent. Format: customers/{customer_id}/webhooks/{webhook_id}

Query
pageSizeinteger(int32)

The maximum number of webhook invocations to return. If unspecified, at most 50 will be returned. Ordered by creation date.

pageTokenstring

A page token, received from a previous ListWebhookInvocations call. Provide this to retrieve the subsequent page.

filters.statesArray of strings

Invocation status to filter by (OR combined).

  • INVOCATION_STATUS_UNSPECIFIED: Unspecified - do not use.
  • INVOCATION_STATUS_PENDING: Invocation is still pending completion.
  • INVOCATION_STATUS_SUCCESS: Invocation completed successfully.
  • INVOCATION_STATUS_ERROR: Invocation completed with an error.
Items Enum"INVOCATION_STATUS_UNSPECIFIED""INVOCATION_STATUS_PENDING""INVOCATION_STATUS_SUCCESS""INVOCATION_STATUS_ERROR"
profileIdstring

The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0131::request-unknown-fields=disabled --).

curl -i -X GET \
  'https://{api-domain}.cresta.com/v1/{parent=customers/*/webhooks/*}/invocations'

Responses

A successful response.

Bodyapplication/json
webhookInvocationsArray of objects(An individual webhook invocation. Next ID: 12)read-only

The matching webhooks.

nextPageTokenstring

Token is used to retrieve the next page.

Response
application/json
{
  "webhookInvocations": [
    { … }
  ],
  "nextPageToken": "string"
}

Get a list of webhooks.

Request

Path
parentstringrequired

Resource name of the parent. Format: customers/{customer_id}

Query
pageSizeinteger(int32)

The maximum number of webhooks to return. If unspecified, at most 50 will be returned.

pageTokenstring

A page token, received from a previous ListWebhooks call. Provide this to retrieve the subsequent page.

profileIdstring

The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0131::request-unknown-fields=disabled --).

curl -i -X GET \
  'https://{api-domain}.cresta.com/v1/{parent=customers/*}/webhooks'

Responses

A successful response.

Bodyapplication/json
webhooksArray of objects(Burger Webhook. Next ID: 12)read-only

The matching webhooks.

nextPageTokenstring

Token is used to retrieve the next page.

Response
application/json
{
  "webhooks": [
    { … }
  ],
  "nextPageToken": "string"
}

Create a new webhook.

Request

Path
parentstringrequired

Resource name of the parent. Format: customers/{customer_id}

webhookIdstringrequired

The resource ID of the webhook

Query
profileIdstring

The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0133::request-unknown-fields=disabled --).

Bodyapplication/jsonrequired

The webhook to be created.

namestring(Resource name of a webhook Format: customers/{customer_id}/webhooks/{webhook_id})
displayNamestring(A user-displayed name of the webhook)required
contextstring(WebhookContext)

The available context types for a webhook.

  • CONTEXT_UNSPECIFIED: Unspecified - do not use.
  • CONVERSATION: Conversation.
Default "CONTEXT_UNSPECIFIED"
Enum"CONTEXT_UNSPECIFIED""CONVERSATION"
webhookTypestring(The type of the webhook)
  • WEBHOOK_TYPE_UNSPECIFIED: Unspecified - do not use.
  • INCOMING: An incoming webhook.
  • OUTGOING_SYNC: A synchronous outgoing webhook.
  • OUTGOING_ASYNC: An asynchronous outgoing webhook.
Default "WEBHOOK_TYPE_UNSPECIFIED"
Enum"WEBHOOK_TYPE_UNSPECIFIED""INCOMING""OUTGOING_SYNC""OUTGOING_ASYNC"
statestring(All possible states of an webhook)
  • STATE_UNSPECIFIED: Unspecified - do not use.
  • STATE_ACTIVE: The webhook is active.
  • STATE_INACTIVE: The webhook is inactive and will not be fired.
  • STATE_DELETED: The webhook has been deleted.
Default "STATE_UNSPECIFIED"
Enum"STATE_UNSPECIFIED""STATE_ACTIVE""STATE_INACTIVE""STATE_DELETED"
incomingWebhookConfigobject(Incoming webhook configuration. Next ID: 5)
outgoingWebhookConfigobject(The outgoing webhook config. Next ID: 10)
curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{parent=customers/*}/webhooks/{webhookId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "string",
    "context": "CONTEXT_UNSPECIFIED",
    "webhookType": "WEBHOOK_TYPE_UNSPECIFIED",
    "state": "STATE_UNSPECIFIED",
    "incomingWebhookConfig": {
      "resourceNameJsonPath": "string",
      "externalIdJsonPath": "string",
      "fieldMapping": [
        {
          "fromJsonPath": "string",
          "toMetadataTaxonomy": "string"
        }
      ],
      "basicAuthentication": {
        "username": "string",
        "password": "string"
      },
      "ignoreMissingResource": true
    },
    "outgoingWebhookConfig": {
      "uri": "string",
      "method": "string",
      "basic": {
        "username": "string",
        "password": "string"
      },
      "bearer": {
        "token": "string"
      },
      "oauth2": {
        "grantType": "OAUTH2_GRANT_TYPE_UNSPECIFIED",
        "jwtParameters": {
          "iss": "string",
          "aud": "string",
          "sub": "string",
          "otherInputClaims": {
            "property1": "string",
            "property2": "string"
          },
          "privateKey": "string"
        },
        "clientCredentialParameters": {
          "clientId": "string",
          "clientSecret": "string"
        },
        "passwordCredentialsParameters": {
          "username": "string",
          "password": "string",
          "clientId": "string",
          "clientSecret": "string"
        },
        "scope": "string",
        "accessTokenUri": "string",
        "authStyle": "AUTH_STYLE_UNSPECIFIED",
        "doNotFormUrlencodeBasicAuth": true
      },
      "headers": [
        {
          "name": "string",
          "value": "string",
          "type": "HEADER_TYPE_UNSPECIFIED"
        }
      ],
      "body": "string",
      "bodySyntaxVersion": 0,
      "retryOptions": {
        "maxRetries": 0,
        "minRetryWait": "string",
        "maxRetryWait": "string",
        "timeout": "string",
        "retryStatusCodes": [
          0
        ]
      }
    }
  }'

Responses

A successful response.

Bodyapplication/json
webhookobject(Burger Webhook. Next ID: 12)
Response
application/json
{
  "webhook": {
    "name": "string",
    "displayName": "string",
    "context": "CONTEXT_UNSPECIFIED",
    "webhookType": "WEBHOOK_TYPE_UNSPECIFIED",
    "state": "STATE_UNSPECIFIED",
    "incomingWebhookConfig": { … },
    "outgoingWebhookConfig": { … },
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "creator": "string",
    "lastEditor": "string"
  }
}

Update an individual webhook.

Request

Path
webhook.namestringrequired

Resource name of a webhook Format: customers/{customer_id}/webhooks/{webhook_id}

Bodyapplication/jsonrequired
webhookobject(Burger Webhook. Next ID: 12)
profileIdstring(The ID identifying the profile to use for this request. This is required for multi-tenancy use cases if the different profiles of a single customer are served by the shared cresta-api but have not been migrated to a single DB yet. (-- api-linter: core::0134::request-unknown-fields=disabled --))
curl -i -X PATCH \
  'https://{api-domain}.cresta.com/v1/{webhook.name=customers/*/profiles/*/webhooks/*}' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhook": {
      "name": "string",
      "displayName": "string",
      "context": "CONTEXT_UNSPECIFIED",
      "webhookType": "WEBHOOK_TYPE_UNSPECIFIED",
      "state": "STATE_UNSPECIFIED",
      "incomingWebhookConfig": {
        "resourceNameJsonPath": "string",
        "externalIdJsonPath": "string",
        "fieldMapping": [
          {
            "fromJsonPath": "string",
            "toMetadataTaxonomy": "string"
          }
        ],
        "basicAuthentication": {
          "username": "string",
          "password": "string"
        },
        "ignoreMissingResource": true
      },
      "outgoingWebhookConfig": {
        "uri": "string",
        "method": "string",
        "basic": {
          "username": "string",
          "password": "string"
        },
        "bearer": {
          "token": "string"
        },
        "oauth2": {
          "grantType": "OAUTH2_GRANT_TYPE_UNSPECIFIED",
          "jwtParameters": {
            "iss": "string",
            "aud": "string",
            "sub": "string",
            "otherInputClaims": {
              "property1": "string",
              "property2": "string"
            },
            "privateKey": "string"
          },
          "clientCredentialParameters": {
            "clientId": "string",
            "clientSecret": "string"
          },
          "passwordCredentialsParameters": {
            "username": "string",
            "password": "string",
            "clientId": "string",
            "clientSecret": "string"
          },
          "scope": "string",
          "accessTokenUri": "string",
          "authStyle": "AUTH_STYLE_UNSPECIFIED",
          "doNotFormUrlencodeBasicAuth": true
        },
        "headers": [
          {
            "name": "string",
            "value": "string",
            "type": "HEADER_TYPE_UNSPECIFIED"
          }
        ],
        "body": "string",
        "bodySyntaxVersion": 0,
        "retryOptions": {
          "maxRetries": 0,
          "minRetryWait": "string",
          "maxRetryWait": "string",
          "timeout": "string",
          "retryStatusCodes": [
            0
          ]
        }
      }
    },
    "profileId": "string"
  }'

Responses

A successful response.

Bodyapplication/json
webhookobject(Burger Webhook. Next ID: 12)
Response
application/json
{
  "webhook": {
    "name": "string",
    "displayName": "string",
    "context": "CONTEXT_UNSPECIFIED",
    "webhookType": "WEBHOOK_TYPE_UNSPECIFIED",
    "state": "STATE_UNSPECIFIED",
    "incomingWebhookConfig": { … },
    "outgoingWebhookConfig": { … },
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "creator": "string",
    "lastEditor": "string"
  }
}