Webhook - Create Or Update

Create the webhook identified by webhook name.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}?api-version=2015-10-31

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

Name of an Azure Resource group.

Regex pattern: ^[-\w\._]+$

automationAccountName
path True
  • string

The name of the automation account.

webhookName
path True
  • string

The webhook name.

api-version
query True
  • string

Client Api Version.

Request Body

Name Required Type Description
name True
  • string

Gets or sets the name of the webhook.

properties.expiryTime
  • string

Gets or sets the expiry time.

properties.isEnabled
  • boolean

Gets or sets the value of the enabled flag of webhook.

properties.parameters
  • object

Gets or sets the parameters of the job.

properties.runOn
  • string

Gets or sets the name of the hybrid worker group the webhook job will run on.

properties.runbook

Gets or sets the runbook.

properties.uri
  • string

Gets or sets the uri.

Responses

Name Type Description
200 OK

OK

201 Created

Created

Other Status Codes

Automation error response describing why the operation failed.

Examples

Create or update webhook

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook?api-version=2015-10-31
{
  "name": "TestWebhook",
  "properties": {
    "isEnabled": true,
    "uri": "https://s1events.azure-automation.net/webhooks?token=7u3KfQvM1vUPWaDMFRv2%2fAA4Jqx8QwS8aBuyO6Xsdcw%3d",
    "expiryTime": "2018-03-29T22:18:13.7002872Z",
    "runbook": {
      "name": "TestRunbook"
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
  "name": "TestWebhook",
  "type": "Microsoft.Automation/AutomationAccounts/Webhooks",
  "properties": {
    "isEnabled": true,
    "expiryTime": "2018-03-29T22:18:13.7002872+00:00",
    "runbook": {
      "name": "TestRunbook"
    },
    "lastInvokedTime": null,
    "runOn": null,
    "parameters": null,
    "uri": "",
    "creationTime": "2017-03-29T22:18:14.6651862+00:00",
    "lastModifiedBy": "",
    "lastModifiedTime": "2017-03-29T22:18:14.6651862+00:00"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
  "name": "TestWebhook",
  "type": "Microsoft.Automation/AutomationAccounts/Webhooks",
  "properties": {
    "isEnabled": true,
    "expiryTime": "2018-03-29T22:18:13.7002872+00:00",
    "runbook": {
      "name": "TestRunbook"
    },
    "lastInvokedTime": null,
    "runOn": null,
    "parameters": null,
    "uri": "",
    "creationTime": "2017-03-29T22:18:14.6651862+00:00",
    "lastModifiedBy": "",
    "lastModifiedTime": "2017-03-29T22:18:14.6651862+00:00"
  }
}

Definitions

ErrorResponse

Error response of an operation failure

RunbookAssociationProperty

The runbook property associated with the entity.

Webhook

Definition of the webhook type.

WebhookCreateOrUpdateParameters

The parameters supplied to the create or update webhook operation.

ErrorResponse

Error response of an operation failure

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.

RunbookAssociationProperty

The runbook property associated with the entity.

Name Type Description
name
  • string

Gets or sets the name of the runbook.

Webhook

Definition of the webhook type.

Name Type Description
id
  • string

Fully qualified resource Id for the resource

name
  • string

The name of the resource

properties.creationTime
  • string

Gets or sets the creation time.

properties.description
  • string

Gets or sets the description.

properties.expiryTime
  • string

Gets or sets the expiry time.

properties.isEnabled
  • boolean

Gets or sets the value of the enabled flag of the webhook.

properties.lastInvokedTime
  • string

Gets or sets the last invoked time.

properties.lastModifiedBy
  • string

Details of the user who last modified the Webhook

properties.lastModifiedTime
  • string

Gets or sets the last modified time.

properties.parameters
  • object

Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.

properties.runOn
  • string

Gets or sets the name of the hybrid worker group the webhook job will run on.

properties.runbook

Gets or sets the runbook the webhook is associated with.

properties.uri
  • string

Gets or sets the webhook uri.

type
  • string

The type of the resource.

WebhookCreateOrUpdateParameters

The parameters supplied to the create or update webhook operation.

Name Type Description
name
  • string

Gets or sets the name of the webhook.

properties.expiryTime
  • string

Gets or sets the expiry time.

properties.isEnabled
  • boolean

Gets or sets the value of the enabled flag of webhook.

properties.parameters
  • object

Gets or sets the parameters of the job.

properties.runOn
  • string

Gets or sets the name of the hybrid worker group the webhook job will run on.

properties.runbook

Gets or sets the runbook.

properties.uri
  • string

Gets or sets the uri.