# Update existing webhook.

`PUT /v1/webhooks/{id}`

Update an existing webhook's information. If you wish to reset the secret, submit any value as the "secret". Firefly III will take this as a hint and reset the secret of the webhook.

Authentication (security requirement alternatives):

```json
[
  {
    "firefly_iii_auth": []
  },
  {
    "local_bearer_auth": []
  }
]
```

- firefly_iii_auth: oauth2. OAuth2 authorization code flow. Create a client on your installation's `/profile` page; it authorizes at `/oauth/authorize` and issues tokens at `/oauth/token` there. The URLs below are the demo site's. [How to use the API](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/api/index.md) walks through it.
- local_bearer_auth: http (bearer). A Personal Access Token, sent as a bearer token. Create one on your installation under Options > Profile > OAuth > Personal Access Tokens.

Parameters:

- `X-Trace-Id` (header, string, uuid, optional) - Unique identifier associated with this request.
  Type: string, uuid
  
  Example:
  
  ```json
  "40c71bbb-c676-4f24-83cf-cc725d7d7a00"
  ```

- `id` (path, string, required) - The webhook ID.
  Type: string
  
  Example:
  
  ```json
  "123"
  ```

Request body: application/json (required)

JSON array with updated webhook information. See the model for the exact specifications.

Type: object

Schema: [WebhookUpdate](https://sourcey-firefly.pages.dev/api/models/webhookupdate/index.md)

- `active` (optional)
  Type: boolean
  
  Boolean to indicate if the webhook is active
  
  Example:
  
  ```json
  false
  ```

- `title` (optional)
  Type: string, string
  
  A title for the webhook for easy recognition.
  
  Example:
  
  ```json
  "Update magic mirror on new transaction"
  ```

- `secret` (optional)
  Type: string, string
  
  A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted.
  
  Example:
  
  ```json
  "iMLZLtLx2JHWhK9Dtyuoqyir"
  ```

- `triggers` (optional)
  Reference: [WebhookTriggerArray](https://sourcey-firefly.pages.dev/api/models/webhooktriggerarray/index.md); Type: array
  
  minItems: 1
  
  maxItems: 3
  
  Example:
  
  ```json
  [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ]
  ```

- `responses` (optional)
  Reference: [WebhookResponseArray](https://sourcey-firefly.pages.dev/api/models/webhookresponsearray/index.md); Type: array
  
  minItems: 1
  
  maxItems: 1
  
  Example:
  
  ```json
  [
    "TRANSACTIONS"
  ]
  ```

- `deliveries` (optional)
  Reference: [WebhookDeliveryArray](https://sourcey-firefly.pages.dev/api/models/webhookdeliveryarray/index.md); Type: array
  
  minItems: 1
  
  maxItems: 1
  
  Example:
  
  ```json
  [
    "JSON"
  ]
  ```

- `url` (optional)
  Type: string, string
  
  The URL of the webhook. Has to start with `https`.
  
  Example:
  
  ```json
  "https://example.com"
  ```

Request body: application/x-www-form-urlencoded (required)

JSON array with updated webhook information. See the model for the exact specifications.

Type: object

Schema: [WebhookUpdate](https://sourcey-firefly.pages.dev/api/models/webhookupdate/index.md)

- `active` (optional)
  Type: boolean
  
  Boolean to indicate if the webhook is active
  
  Example:
  
  ```json
  false
  ```

- `title` (optional)
  Type: string, string
  
  A title for the webhook for easy recognition.
  
  Example:
  
  ```json
  "Update magic mirror on new transaction"
  ```

- `secret` (optional)
  Type: string, string
  
  A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted.
  
  Example:
  
  ```json
  "iMLZLtLx2JHWhK9Dtyuoqyir"
  ```

- `triggers` (optional)
  Reference: [WebhookTriggerArray](https://sourcey-firefly.pages.dev/api/models/webhooktriggerarray/index.md); Type: array
  
  minItems: 1
  
  maxItems: 3
  
  Example:
  
  ```json
  [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ]
  ```

- `responses` (optional)
  Reference: [WebhookResponseArray](https://sourcey-firefly.pages.dev/api/models/webhookresponsearray/index.md); Type: array
  
  minItems: 1
  
  maxItems: 1
  
  Example:
  
  ```json
  [
    "TRANSACTIONS"
  ]
  ```

- `deliveries` (optional)
  Reference: [WebhookDeliveryArray](https://sourcey-firefly.pages.dev/api/models/webhookdeliveryarray/index.md); Type: array
  
  minItems: 1
  
  maxItems: 1
  
  Example:
  
  ```json
  [
    "JSON"
  ]
  ```

- `url` (optional)
  Type: string, string
  
  The URL of the webhook. Has to start with `https`.
  
  Example:
  
  ```json
  "https://example.com"
  ```

Responses:

- 200: Updated webhook stored, result in response

Content type: application/vnd.api+json

Type: object

Schema: [WebhookSingle](https://sourcey-firefly.pages.dev/api/models/webhooksingle/index.md)

- `data` (required)
  Reference: [WebhookRead](https://sourcey-firefly.pages.dev/api/models/webhookread/index.md); Type: object

- 400: Bad request

Content type: application/json

Type: object

Schema: [BadRequestResponse](https://sourcey-firefly.pages.dev/api/models/badrequestresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Bad Request"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "BadRequestHttpException"
  ```

- 401: Unauthenticated

Content type: application/json

Type: object

Schema: [UnauthenticatedResponse](https://sourcey-firefly.pages.dev/api/models/unauthenticatedresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Unauthenticated"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "AuthenticationException"
  ```

- 404: Page not found

Content type: application/json

Type: object

Schema: [NotFoundResponse](https://sourcey-firefly.pages.dev/api/models/notfoundresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Resource not found"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "NotFoundHttpException"
  ```

- 422: Validation error. The body will have the exact details.

Content type: application/json

Type: object

Schema: [ValidationErrorResponse](https://sourcey-firefly.pages.dev/api/models/validationerrorresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "The given data was invalid."
  ```

- `errors` (optional)
  Type: object
  
  - `email` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `force` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `blocked` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `field` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `role` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `blocked_code` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `name` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `type` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `iban` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `start` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `end` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `date` (optional)
    Type: array
    
    Items:
      Type: string, string

- 500: Internal exception

Content type: application/json

Type: object

Schema: [InternalExceptionResponse](https://sourcey-firefly.pages.dev/api/models/internalexceptionresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Internal Exception"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "InternalException"
  ```

## Examples

### cURL

```bash
curl -X PUT 'https://firefly.example.com/api/v1/webhooks/123' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "active": false,
  "title": "Update magic mirror on new transaction",
  "secret": "iMLZLtLx2JHWhK9Dtyuoqyir",
  "triggers": [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ],
  "responses": [
    "TRANSACTIONS"
  ],
  "deliveries": [
    "JSON"
  ],
  "url": "https://example.com"
}'
```

### JavaScript

```javascript
const body = `{
  "active": false,
  "title": "Update magic mirror on new transaction",
  "secret": "iMLZLtLx2JHWhK9Dtyuoqyir",
  "triggers": [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ],
  "responses": [
    "TRANSACTIONS"
  ],
  "deliveries": [
    "JSON"
  ],
  "url": "https://example.com"
}`;

const response = await fetch('https://firefly.example.com/api/v1/webhooks/123', {
  method: 'PUT',
  headers: {
    'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();
```

### Python

```python
import requests

body = '''{
  "active": false,
  "title": "Update magic mirror on new transaction",
  "secret": "iMLZLtLx2JHWhK9Dtyuoqyir",
  "triggers": [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ],
  "responses": [
    "TRANSACTIONS"
  ],
  "deliveries": [
    "JSON"
  ],
  "url": "https://example.com"
}'''

response = requests.put(
    'https://firefly.example.com/api/v1/webhooks/123',
    data=body.encode('utf-8'),
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)
```